From c9d0e8e9c67fbe5278f2450975afcd42f8343727 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 22 Oct 2024 23:56:35 +0200 Subject: [PATCH] Replacing BuildTheDocs. --- .btd.yml | 9 --------- .github/workflows/_Checking_Pipeline.yml | 25 +++++++++++++++++++++++- doc/conf.py | 1 - 3 files changed, 24 insertions(+), 11 deletions(-) delete mode 100644 .btd.yml diff --git a/.btd.yml b/.btd.yml deleted file mode 100644 index 296c029..0000000 --- a/.btd.yml +++ /dev/null @@ -1,9 +0,0 @@ -input: doc -output: _build -requirements: requirements.txt -target: gh-pages -formats: [ html ] -images: - base: btdi/sphinx:pytooling - latex: btdi/latex -theme: https://codeload.GitHub.com/buildthedocs/sphinx.theme/tar.gz/v1 diff --git a/.github/workflows/_Checking_Pipeline.yml b/.github/workflows/_Checking_Pipeline.yml index fab1198..969536f 100644 --- a/.github/workflows/_Checking_Pipeline.yml +++ b/.github/workflows/_Checking_Pipeline.yml @@ -117,11 +117,34 @@ jobs: with: artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }} + HTMLDocumentation: + uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@py313 + needs: + - UnitTestingParams +# - VerifyDocs + with: + python_version: ${{ needs.UnitTestingParams.outputs.python_version }} +# unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }} +# coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }} + html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }} + latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }} + + PDFDocumentation: + uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r1 + needs: + - UnitTestingParams + - HTMLDocumentation + with: + document: actions + 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@py313 needs: - UnitTestingParams - - BuildTheDocs + - HTMLDocumentation + - PDFDocumentation # - Coverage - PublishCoverageResults - StaticTypeCheck diff --git a/doc/conf.py b/doc/conf.py index 50f9c22..1c3ddca 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -186,7 +186,6 @@ extensions = [ # SphinxContrib extensions "sphinxcontrib.mermaid", # Other extensions - "sphinx_fontawesome", "sphinx_autodoc_typehints", "sphinx_inline_tabs", "autoapi.sphinx",