Allow to enabled/disable MiKTeX updates. default: disabled

Author: Paebbels

.github/workflows/CompletePipeline.yml

@@ -128,6 +128,11 @@ on:
         required: false
         default: 'pytooling/miktex:sphinx'
         type: string
+      miktex_update:
+        description: 'Update MiKTeX packages.'
+        required: false
+        default: 'false'
+        type: string
       auto_tag:
         description: 'Auto tag if a branch was merged to the release branch and an associated pull-request with matching version name was found.'
         required: false
@@ -415,6 +420,7 @@ jobs:
       pdf_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
       can-fail:       'true'
       miktex_image:   ${{ inputs.miktex_image }}
+      update:         ${{ inputs.miktex_update }}
 
   PublishToGitHubPages:
     uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev

.github/workflows/LaTeXDocumentation.yml

@@ -42,6 +42,11 @@ on:
         required: false
         default: 'pytooling/miktex:sphinx'
         type: string
+      update:
+        description: 'Update MiKTeX packages.'
+        required: false
+        default: 'false'
+        type: string
       processor:
         description: 'Name of the used LaTeX processor.'
         required: false
@@ -79,10 +84,15 @@ jobs:
           investigate: 'true'
 
       - name: ⚙️ Update
+        if: inputs.update == 'true'
         run: |
+          printf -- "Update package database (miktex --admin packages update-package-database) ...\n"
           sudo miktex --admin packages update-package-database
+          printf -- "Update packages (miktex --admin packages update) ...\n"
           sudo miktex --admin packages update
+          printf -- "Update filename database (initexmf --admin --updatefndb) ...\n"
           sudo initexmf --admin --update-fndb
+          printf -- "DONE\n"
 
       - name: 📖 Build LaTeX document using 'pytooling/miktex:sphinx'
         if: inputs.pdf_artifact != ''

README.md

@@ -120,7 +120,7 @@ Find further usage cases in the following list of projects:
 
 ## License
 
-This Python package (source code) licensed under [Apache License 2.0](LICENSE.md).
+This Python package (source code) is licensed under [Apache License 2.0](LICENSE.md).
 The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).
 
 ---

doc/Glossary.rst

@@ -39,7 +39,7 @@ Glossary
 
      :Source Code:   `github.com/GeekyEggo/delete-artifact/ <https://github.com/GeekyEggo/delete-artifact/>`__
      :Marketplace:   `github.com/marketplace/actions/delete-artifact/ <https://github.com/marketplace/actions/delete-artifact/>`__
-     :README:        `github.com/GeekyEggo/delete-artifact ⭢ README.md <https://github.com/GeekyEggo/delete-artifact/blob/main/README.md>`__
+     :README:        `github.com/GeekyEggo/delete-artifact → README.md <https://github.com/GeekyEggo/delete-artifact/blob/main/README.md>`__
 
    docstr_coverage
      Docstring coverage analysis and rating for Python.
@@ -118,7 +118,7 @@ Glossary
 
      :Source Code:   `github.com/dorny/test-reporter/ <https://github.com/dorny/test-reporter/>`__
      :Marketplace:   `github.com/marketplace/actions/test-reporter/ <https://github.com/marketplace/actions/test-reporter/>`__
-     :README:        `github.com/dorny/test-reporter ⭢ README.md <https://github.com/dorny/test-reporter/blob/main/README.md>`__
+     :README:        `github.com/dorny/test-reporter → README.md <https://github.com/dorny/test-reporter/blob/main/README.md>`__
 
    twine
      Utilities for interacting with PyPI.

doc/requirements.txt

@@ -15,5 +15,5 @@ sphinxcontrib-mermaid ~= 2.0
 autoapi >= 2.0.1
 sphinx_design ~= 0.7.0
 sphinx-copybutton >= 0.5.2
-sphinx_autodoc_typehints ~= 3.5   # 3.9 is conflicting with old sphinx_design and rtd theme due to sphinx<9 and docutils<0.22
+sphinx_autodoc_typehints ~= 3.10
 sphinx_reports ~= 0.10.0

tests/unit/requirements.txt

@@ -5,4 +5,4 @@ Coverage ~= 7.13
 
 # Test Runner
 pytest ~= 9.0
-pytest-cov ~= 7.0
+pytest-cov ~= 7.1