Translate LaTeX documentation to PDF.

.github/workflows/CompletePipeline.yml

@@ -33,6 +33,11 @@ on:
         description: 'Name of the tool''s package.'
         required: true
         type: string
+      documentation:
+        description: 'Name of documentation document.'
+        required: false
+        default: ''
+        type: string
       unittest_python_version:
         description: 'Python version.'
         required: false
@@ -126,16 +131,16 @@ on:
 
 jobs:
   Prepare:
-    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@main
+    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev
 
   ConfigParams:
-    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@main
+    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
     with:
       package_namespace: ${{ inputs.package_namespace }}
       package_name:      ${{ inputs.package_name }}
 
   UnitTestingParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       package_namespace:   ${{ inputs.package_namespace }}
       package_name:        ${{ inputs.package_name }}
@@ -147,7 +152,7 @@ jobs:
       disable_list:        ${{ inputs.unittest_disable_list }}
 
 #  AppTestingParams:
-#    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+#    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
 #    with:
 #      package_namespace:   ${{ inputs.package_namespace }}
 #      package_name:        ${{ inputs.package_name }}
@@ -159,7 +164,7 @@ jobs:
 #      disable_list:        ${{ inputs.apptest_disable_list }}
 
   InstallParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       package_namespace:   ${{ inputs.package_namespace }}
       package_name:        ${{ inputs.package_name }}
@@ -171,7 +176,7 @@ jobs:
       disable_list:        ${{ inputs.unittest_disable_list }}
 
   UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -186,7 +191,7 @@ jobs:
       coverage_sqlite_artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
 
   StaticTypeCheck:
-    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
+    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -199,7 +204,7 @@ jobs:
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:
-    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@main
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -208,7 +213,7 @@ jobs:
       directory:      ${{ needs.ConfigParams.outputs.package_directory }}
 
   Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@main
+    uses: pyTooling/Actions/.github/workflows/Package.yml@dev
     needs:
       - UnitTestingParams
 #      - UnitTesting
@@ -217,7 +222,7 @@ jobs:
       artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
 
   Install:
-    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@main
+    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -229,7 +234,7 @@ jobs:
       package_name: ${{ needs.ConfigParams.outputs.package_fullname }}
 
 #  AppTesting:
-#    uses: pyTooling/Actions/.github/workflows/ApplicationTesting.yml@main
+#    uses: pyTooling/Actions/.github/workflows/ApplicationTesting.yml@dev
 #    needs:
 #      - AppTestingParams
 #      - UnitTestingParams
@@ -240,7 +245,7 @@ jobs:
 #      apptest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).apptesting_xml }}
 
   PublishCoverageResults:
-    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -262,7 +267,7 @@ jobs:
       CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}
 
   PublishTestResults:
-    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -277,14 +282,14 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
 #  VerifyDocs:
-#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@main
+#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
 #    needs:
 #      - UnitTestingParams
 #    with:
 #      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
 
   Documentation:
-    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@main
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -300,7 +305,7 @@ jobs:
       latex_artifact:                 ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
   IntermediateCleanUp:
-    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@main
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
     needs:
       - UnitTestingParams
       - PublishCoverageResults
@@ -310,18 +315,18 @@ jobs:
       sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
       xml_unittest_artifacts_prefix:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
 
-#  PDFDocumentation:
-#    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@main
-#    needs:
-#      - UnitTestingParams
-#      - Documentation
-#    with:
-#      document: pyEDAA.ProjectModel
-#      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
-#      pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
+  PDFDocumentation:
+    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@latex
+    needs:
+      - UnitTestingParams
+      - Documentation
+    with:
+      document: ${{ inputs.documentation }}
+      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+      pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
 
   PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
     needs:
       - UnitTestingParams
       - Documentation
@@ -334,7 +339,7 @@ jobs:
       typing:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   TriggerTaggedRelease:
-    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@main
+    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@dev
     needs:
       - Prepare
       - UnitTesting
@@ -353,7 +358,7 @@ jobs:
     secrets: inherit
 
   ReleasePage:
-    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@dev
     needs:
       - Prepare
       - UnitTesting
@@ -371,7 +376,7 @@ jobs:
     secrets: inherit
 
   PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
     needs:
       - Prepare
       - UnitTestingParams
@@ -386,13 +391,13 @@ jobs:
       PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
 
   ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
     needs:
       - UnitTestingParams
       - UnitTesting
       - StaticTypeCheck
       - Documentation
-#      - PDFDocumentation
+      - PDFDocumentation
       - PublishTestResults
       - PublishCoverageResults
       - PublishToGitHubPages

.github/workflows/LaTeXDocumentation.yml

@@ -43,11 +43,19 @@ on:
         required: false
         default: ''
         type: string
+      miktex_image:
+        description: 'Name of the MikTeX image.'
+        required: false
+        default: 'pytooling/miktex:latest'
+        type: string
 
 jobs:
   PDFDocumentation:
     name: 📓 Converting LaTeX Documentation to PDF
     runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}"
+    container:
+      image: ${{ inputs.miktex_image }}
+
     steps:
       - name: 📥 Download artifacts '${{ inputs.latex_artifact }}' from 'SphinxDocumentation' job
         uses: pyTooling/download-artifact@v4
@@ -55,21 +63,17 @@ jobs:
           name: ${{ inputs.latex_artifact }}
           path: latex
 
-      - name: Debug
+      - name: Version check
         run: |
-          tree -pash .
+          echo "which pdflatex: $(which pdflatex)"
+          echo ""
+          pdflatex --version
 
-      - name: Build LaTeX document using 'pytooling/miktex:sphinx'
-        uses: addnab/docker-run-action@v3
-        with:
-          image: pytooling/miktex:sphinx
-          options: -v ${{ github.workspace }}/latex:/latex --workdir /latex
+      - name: Version check
         run: |
-            which pdflatex
-            pwd
-            ls -lAh
-
-            latexmk -xelatex ${{ inputs.document }}.tex
+          cd latex
+          ls -lAh *.tex
+          latexmk ${{ inputs.document }}.tex
 
       - name: 📤 Upload 'PDF Documentation' artifact
         uses: pyTooling/upload-artifact@v4

.github/workflows/_Checking_ArtifactCleanup.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   Params:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.12 3.13"
@@ -50,7 +50,7 @@ jobs:
           retention-days: 1
 
   ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
     needs:
       - Params
       - Testing

.github/workflows/_Checking_JobTemplates.yml

@@ -6,35 +6,35 @@ on:
 
 jobs:
   Prepare:
-    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@main
+    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev
 
   ConfigParams:
-    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@main
+    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
     with:
       package_name: pyDummy
 
   InstallParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       package_name:        pyDummy
       python_version_list: ''
 
   UnitTestingParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: pyDummy
       python_version_list: "3.9 3.10 3.11 3.12 3.13 pypy-3.9 pypy-3.10"
 #      disable_list: "windows:pypy-3.10"
 
   PlatformTestingParams:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Platform
       python_version_list: ""
       system_list: "ubuntu windows macos mingw64 clang64 ucrt64"
 
   UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -51,7 +51,7 @@ jobs:
 #      coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
 
   PlatformTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
     needs:
       - ConfigParams
       - PlatformTestingParams
@@ -70,7 +70,7 @@ jobs:
       coverage_html_artifact:         ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_html }}
 
   StaticTypeCheck:
-    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
+    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -83,7 +83,7 @@ jobs:
       html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   DocCoverage:
-    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@main
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -93,7 +93,7 @@ jobs:
 #      fail_below: 70
 
   Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@main
+    uses: pyTooling/Actions/.github/workflows/Package.yml@dev
     needs:
       - UnitTestingParams
 #      - UnitTesting
@@ -103,7 +103,7 @@ jobs:
       artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
 
   Install:
-    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@main
+    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -115,7 +115,7 @@ jobs:
       package_name: ${{ needs.ConfigParams.outputs.package_fullname }}
 
   PublishCoverageResults:
-    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -136,7 +136,7 @@ jobs:
     secrets: inherit
 
   PublishTestResults:
-    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -151,14 +151,14 @@ jobs:
     secrets: inherit
 
 #  VerifyDocs:
-#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@main
+#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
 #    needs:
 #      - UnitTestingParams
 #    with:
 #      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
 
   Documentation:
-    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@main
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
     needs:
       - ConfigParams
       - UnitTestingParams
@@ -174,7 +174,7 @@ jobs:
       latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
   IntermediateCleanUp:
-    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@main
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
     needs:
       - UnitTestingParams
       - PublishCoverageResults
@@ -184,7 +184,7 @@ jobs:
       xml_unittest_artifacts_prefix:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
 
   PDFDocumentation:
-    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@main
+    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
     needs:
       - UnitTestingParams
       - Documentation
@@ -194,7 +194,7 @@ jobs:
       pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
 
   PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
     needs:
       - UnitTestingParams
       - Documentation
@@ -207,7 +207,7 @@ jobs:
       typing:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
   TriggerTaggedRelease:
-    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@main
+    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@dev
     needs:
       - Prepare
       - UnitTesting
@@ -225,7 +225,7 @@ jobs:
     secrets: inherit
 
   ReleasePage:
-    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@dev
     needs:
       - Prepare
       - UnitTesting
@@ -243,7 +243,7 @@ jobs:
     secrets: inherit
 
   PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
     needs:
       - UnitTestingParams
       - ReleasePage
@@ -256,7 +256,7 @@ jobs:
     secrets: inherit
 
   ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
     needs:
       - UnitTestingParams
       - PlatformTestingParams

.github/workflows/_Checking_NamespacePackage_Pipeline.yml

@@ -6,10 +6,11 @@ on:
 
 jobs:
   NamespacePackage:
-    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@main
+    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@latex
     with:
       package_namespace: pyExamples
       package_name:      Extensions
+      documentation:     Actions
       codecov:           true
       codacy:            true
       dorny:             true

.github/workflows/_Checking_Nightly.yml

@@ -42,7 +42,7 @@ jobs:
           retention-days: 1
 
   NightlyPage:
-    uses: pyTooling/Actions/.github/workflows/NightlyRelease.yml@main
+    uses: ./.github/workflows/NightlyRelease.yml
     needs:
       - Build
     permissions:

.github/workflows/_Checking_Parameters.yml

@@ -6,24 +6,24 @@ on:
 
 jobs:
   Params_Default:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
 
   Params_PythonVersions:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.11 3.12 pypy-3.9 pypy-3.10"
 
   Params_Systems:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       system_list: "windows mingw32 mingw64"
 
   Params_Include:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.11"
@@ -31,7 +31,7 @@ jobs:
       include_list: "ubuntu:3.12 ubuntu:3.13"
 
   Params_Exclude:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.12"
@@ -39,7 +39,7 @@ jobs:
       exclude_list: "windows:3.12 windows:3.13"
 
   Params_Disable:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.12"
@@ -47,7 +47,7 @@ jobs:
       disable_list: "windows:3.12 windows:3.13"
 
   Params_All:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@main
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
     with:
       name: Example
       python_version_list: "3.12 3.13"

.github/workflows/_Checking_SimplePackage_Pipeline.yml

@@ -6,9 +6,10 @@ on:
 
 jobs:
   SimplePackage:
-    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@main
+    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@latex
     with:
       package_name:  pyDummy
+      documentation: Actions
       codecov:       true
       codacy:        true
       dorny:         true