From 67ff17facb1270e4c1affd56647f4c749701a637 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:03:36 +0100 Subject: [PATCH 01/16] using relative paths --- .github/workflows/doc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index fc11b713..916ce0f9 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -29,11 +29,11 @@ jobs: uses: mattnotmitt/doxygen-action@v1.9.5 with: working-directory: docgen_dir - doxyfile-path: doxyconfig/config + doxyfile-path: ./doxyconfig/config enable-latex: true - name: deploy new doc to github pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docgen_dir/html \ No newline at end of file + publish_dir: ./docgen_dir/html From c1738fc8ec8d72815a38033e56c5a4a2241878f3 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:05:57 +0100 Subject: [PATCH 02/16] making doxy path relative to working direc --- .github/workflows/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 916ce0f9..a717ea50 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -29,7 +29,7 @@ jobs: uses: mattnotmitt/doxygen-action@v1.9.5 with: working-directory: docgen_dir - doxyfile-path: ./doxyconfig/config + doxyfile-path: ../doxyconfig/config enable-latex: true - name: deploy new doc to github pages From e2a38dbbfb4a89ace4f070261649a0c07f85d677 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:09:52 +0100 Subject: [PATCH 03/16] working directly from doxyconfig --- .github/workflows/doc.yml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index a717ea50..84c726d2 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -22,18 +22,15 @@ jobs: - name: obtain copy of repository uses: actions/checkout@v1 - - name: make a directory for the generated doc - run: mkdir docgen_dir - - - name: run doxygen to generate doc, outputting to docgen_dir + - name: run doxygen to generate doc, outputting inside doxyconfig/html uses: mattnotmitt/doxygen-action@v1.9.5 with: - working-directory: docgen_dir - doxyfile-path: ../doxyconfig/config + working-directory: doxyconfig + doxyfile-path: doxyconfig/config enable-latex: true - name: deploy new doc to github pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docgen_dir/html + publish_dir: doxyconfig/html From 03b5caf339d4232ea0233db9426359b83f45c150 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:11:02 +0100 Subject: [PATCH 04/16] making relative again --- .github/workflows/doc.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 84c726d2..5b7884f0 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -25,12 +25,12 @@ jobs: - name: run doxygen to generate doc, outputting inside doxyconfig/html uses: mattnotmitt/doxygen-action@v1.9.5 with: - working-directory: doxyconfig - doxyfile-path: doxyconfig/config + working-directory: ./doxyconfig + doxyfile-path: ./doxyconfig/config enable-latex: true - name: deploy new doc to github pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: doxyconfig/html + publish_dir: ./doxyconfig/html From 93bae9823bebed9dc9e31f7ed75a777c7786ca02 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:12:46 +0100 Subject: [PATCH 05/16] is this sufficient? --- .github/workflows/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 5b7884f0..84dd06a2 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -26,7 +26,7 @@ jobs: uses: mattnotmitt/doxygen-action@v1.9.5 with: working-directory: ./doxyconfig - doxyfile-path: ./doxyconfig/config + doxyfile-path: config enable-latex: true - name: deploy new doc to github pages From 2dee2c8f65a09c0964250c1e78d7616e72c4adc6 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:14:27 +0100 Subject: [PATCH 06/16] surely this'll do it --- .github/workflows/doc.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 84dd06a2..3a6a65c2 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -22,15 +22,14 @@ jobs: - name: obtain copy of repository uses: actions/checkout@v1 - - name: run doxygen to generate doc, outputting inside doxyconfig/html + - name: run doxygen to generate doc, outputting inside /html uses: mattnotmitt/doxygen-action@v1.9.5 with: - working-directory: ./doxyconfig - doxyfile-path: config + doxyfile-path: doxyconfig/config enable-latex: true - name: deploy new doc to github pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./doxyconfig/html + publish_dir: html From f49ca78a8f698a7dbfad22e6b29309fb2e01aa82 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:22:20 +0100 Subject: [PATCH 07/16] pointing github pages to correct output dir --- .github/workflows/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 3a6a65c2..f7bb975e 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -32,4 +32,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: html + publish_dir: Doxygen_doc/html From 0129cb2f852f824b1e3071cd94aae1354be1841a Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:37:38 +0100 Subject: [PATCH 08/16] updating config for new doxygen version --- doxyconfig/config | 76 ++--------------------------------------------- 1 file changed, 2 insertions(+), 74 deletions(-) diff --git a/doxyconfig/config b/doxyconfig/config index 9d289f4f..a6354c69 100644 --- a/doxyconfig/config +++ b/doxyconfig/config @@ -231,12 +231,6 @@ TAB_SIZE = 8 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -995,13 +989,6 @@ VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = NO -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored @@ -1405,17 +1392,6 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 12 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using prerendered bitmaps. Use this if you do not have LaTeX @@ -1558,7 +1534,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = NO +GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1601,7 +1577,7 @@ COMPACT_LATEX = YES # The default value is: a4. # This tag requires that the tag GENERATE_LATEX is set to YES. -PAPER_TYPE = a4wide +PAPER_TYPE = a4 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names # that should be included in the LaTeX output. To get the times font for @@ -1678,16 +1654,6 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. @@ -2021,15 +1987,6 @@ EXTERNAL_PAGES = NO # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2062,23 +2019,6 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font n the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - # By default doxygen will tell dot to use the default font as specified with # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set # the path where dot can find it using this tag. @@ -2267,18 +2207,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support From 697d6ee200d0481b131516c055bae066fc037bc2 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 19:54:09 +0100 Subject: [PATCH 09/16] trying to put latex in base directory --- doxyconfig/config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxyconfig/config b/doxyconfig/config index a6354c69..de233e09 100644 --- a/doxyconfig/config +++ b/doxyconfig/config @@ -1542,7 +1542,7 @@ GENERATE_LATEX = YES # The default directory is: latex. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_OUTPUT = latex +LATEX_OUTPUT = . # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. From 3fbbf68fcedd2fc9280078e022293211afab6f5a Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 20:06:29 +0100 Subject: [PATCH 10/16] prevent action from invoking latex final cmd --- doxyconfig/config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxyconfig/config b/doxyconfig/config index de233e09..e91222b7 100644 --- a/doxyconfig/config +++ b/doxyconfig/config @@ -1534,7 +1534,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of From 08e7408153c5c013431ab299aaa2fee2837482ef Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 20:08:49 +0100 Subject: [PATCH 11/16] trying manual latex since the doxygen github action confounds generating of latex doc, and generation of latex snippets in doc --- .github/workflows/doc.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index f7bb975e..ae2c25c9 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -22,11 +22,13 @@ jobs: - name: obtain copy of repository uses: actions/checkout@v1 + - name: install latex + run: apk add perl build-base texlive-full biblatex ghostscript + - name: run doxygen to generate doc, outputting inside /html uses: mattnotmitt/doxygen-action@v1.9.5 with: doxyfile-path: doxyconfig/config - enable-latex: true - name: deploy new doc to github pages uses: peaceiris/actions-gh-pages@v3 From 49c5f0529369b430b1dcfc8564c0a19afdb22eb6 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 21:19:20 +0100 Subject: [PATCH 12/16] try with mathjax instead --- doxyconfig/config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxyconfig/config b/doxyconfig/config index e91222b7..28362817 100644 --- a/doxyconfig/config +++ b/doxyconfig/config @@ -1401,7 +1401,7 @@ FORMULA_FONTSIZE = 12 # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = NO +USE_MATHJAX = YES # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: From 890fd4aa6a7ab25366c7c615ec297386c3ed36af Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 21:20:26 +0100 Subject: [PATCH 13/16] woops, removing apk invocation --- .github/workflows/doc.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index ae2c25c9..e2c5442f 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -22,9 +22,6 @@ jobs: - name: obtain copy of repository uses: actions/checkout@v1 - - name: install latex - run: apk add perl build-base texlive-full biblatex ghostscript - - name: run doxygen to generate doc, outputting inside /html uses: mattnotmitt/doxygen-action@v1.9.5 with: From 2218617a86405ec6aa285316c62e8c9f4fd0b229 Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 21:32:57 +0100 Subject: [PATCH 14/16] attempted fix of pages push --- .github/workflows/doc.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index e2c5442f..906feaae 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -2,6 +2,8 @@ name: doc permissions: contents: write + pages: write + id-token: write on: # regenerate when master branch is updated @@ -22,7 +24,7 @@ jobs: - name: obtain copy of repository uses: actions/checkout@v1 - - name: run doxygen to generate doc, outputting inside /html + - name: run doxygen to generate doc, outputting to Doxygen_doc/html uses: mattnotmitt/doxygen-action@v1.9.5 with: doxyfile-path: doxyconfig/config @@ -31,4 +33,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: Doxygen_doc/html + publish_dir: ./Doxygen_doc/html From 8be886efc5d225038a99e102358b58d2d9b661aa Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 21:39:08 +0100 Subject: [PATCH 15/16] hmm shouldn't work but ya never know ay --- .github/workflows/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 906feaae..3c39a8bc 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -33,4 +33,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./Doxygen_doc/html + publish_dir: . From daa1c73ec0003c3868ef993d6b6f0457da2fe87e Mon Sep 17 00:00:00 2001 From: Tyson Jones Date: Mon, 7 Aug 2023 21:45:28 +0100 Subject: [PATCH 16/16] away with that action, avast! --- .github/workflows/doc.yml | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 3c39a8bc..2f60d243 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -14,12 +14,22 @@ on: # or when manually triggered from the Actions tab workflow_dispatch: +# prevent concurrent deployments +concurrency: + group: "pages" + cancel-in-progress: false + + jobs: build-doc: name: Generation of documentation runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: - name: obtain copy of repository uses: actions/checkout@v1 @@ -29,8 +39,15 @@ jobs: with: doxyfile-path: doxyconfig/config - - name: deploy new doc to github pages - uses: peaceiris/actions-gh-pages@v3 + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: . + # Upload Doxygen_doc/html + path: ./Doxygen_doc/html + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2