From a4559e8e6357a38476033450b4dac17b44d70b58 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sat, 21 Dec 2024 10:15:04 +0100 Subject: [PATCH] Build documentation using pyTooling/MikTeX. --- .github/workflows/LaTeXDocumentation.yml | 20 ++++++++++++++++---- .github/workflows/_Checking_JobTemplates.yml | 2 +- doc/shields.inc | 10 +++++----- 3 files changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/workflows/LaTeXDocumentation.yml b/.github/workflows/LaTeXDocumentation.yml index 47d39337..96074b8c 100644 --- a/.github/workflows/LaTeXDocumentation.yml +++ b/.github/workflows/LaTeXDocumentation.yml @@ -55,17 +55,29 @@ jobs: name: ${{ inputs.latex_artifact }} path: latex - - name: Compile LaTeX document - uses: xu-cheng/latex-action@master + - name: Debug + run: | + tree -pash . + + + - name: Build LaTeX document using 'pytooling/miktex:sphinx' + uses: addnab/docker-run-action@v3 with: - working_directory: latex - root_file: ${{ inputs.document }}.tex + image: pytooling/miktex:sphinx + options: -v ${{ github.workspace }}/latex:/latex --workdir /latex + run: | + which pdflatex + pwd + ls -lAh + + latexmk ${{ inputs.document }}.tex - name: 📤 Upload 'PDF Documentation' artifact uses: pyTooling/upload-artifact@v4 if: inputs.pdf_artifact != '' with: name: ${{ inputs.pdf_artifact }} + working-directory: latex path: ${{ inputs.document }}.pdf if-no-files-found: error retention-days: 1 diff --git a/.github/workflows/_Checking_JobTemplates.yml b/.github/workflows/_Checking_JobTemplates.yml index dcac3181..7671ec94 100644 --- a/.github/workflows/_Checking_JobTemplates.yml +++ b/.github/workflows/_Checking_JobTemplates.yml @@ -157,7 +157,7 @@ jobs: - UnitTestingParams - Documentation with: - document: actions + document: Actions latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }} pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }} diff --git a/doc/shields.inc b/doc/shields.inc index 08ea1065..9498bc73 100644 --- a/doc/shields.inc +++ b/doc/shields.inc @@ -4,11 +4,11 @@ # percent encoding so that the URL is properly parsed. .. # Sourcecode link to GitHub -.. |SHIELD:svg:pyTooling-github| image:: https://img.shields.io/badge/pyTooling-Actions-63bf7f.svg?longCache=true&style=flat-square&longCache=true&logo=GitHub +.. |SHIELD:svg:pyTooling-github| image:: https://img.shields.io/badge/pyTooling-Actions-63bf7f?longCache=true&style=flat-square&longCache=true&logo=GitHub :alt: Sourcecode on GitHub :height: 22 :target: https://GitHub.com/pyTooling/Actions -.. |SHIELD:png:pyTooling-github| image:: https://raster.shields.io/badge/pyTooling-Actions-63bf7f.svg?longCache=true&style=flat-square&longCache=true&logo=GitHub +.. |SHIELD:png:pyTooling-github| image:: https://raster.shields.io/badge/pyTooling-Actions-63bf7f?longCache=true&style=flat-square&longCache=true&logo=GitHub :alt: Sourcecode on GitHub :height: 22 :target: https://GitHub.com/pyTooling/Actions @@ -18,7 +18,7 @@ :alt: Code license :height: 22 :target: Code-License.html -.. |SHIELD:png:pyTooling-src-license| image:: https://img.shields.io/pypi/l/pyTooling?longCache=true&style=flat-square&logo=Apache&label=code +.. |SHIELD:png:pyTooling-src-license| image:: https://raster.shields.io/pypi/l/pyTooling?longCache=true&style=flat-square&logo=Apache&label=code :alt: Code license :height: 22 :target: https://GitHub.com/pyTooling/Actions/blob/main/LICENSE.md @@ -64,11 +64,11 @@ :target: https://pyTooling.github.io/pyTooling/ .. # Gitter -.. |SHIELD:svg:pyTooling-gitter| image:: https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef +.. |SHIELD:svg:pyTooling-gitter| image:: https://img.shields.io/badge/chat-on%20gitter-4db797.?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef :alt: Documentation License :height: 22 :target: https://gitter.im/hdl/community -.. |SHIELD:png:pyTooling-gitter| image:: https://raster.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef +.. |SHIELD:png:pyTooling-gitter| image:: https://raster.shields.io/badge/chat-on%20gitter-4db797.?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef :alt: Documentation License :height: 22 :target: https://gitter.im/hdl/community