Translate LaTeX documentation to PDF.

This commit is contained in:
Patrick Lehmann
2024-12-01 19:27:49 +01:00
parent f3e2e42ae3
commit 77a7545f66
4 changed files with 41 additions and 30 deletions

View File

@@ -33,6 +33,11 @@ on:
description: 'Name of the tool''s package.' description: 'Name of the tool''s package.'
required: true required: true
type: string type: string
documentation:
description: 'Name of documentation document.'
required: false
default: ''
type: string
unittest_python_version: unittest_python_version:
description: 'Python version.' description: 'Python version.'
required: false required: false
@@ -310,15 +315,15 @@ jobs:
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}- sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}- xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
# PDFDocumentation: PDFDocumentation:
# uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@latex
# needs: needs:
# - UnitTestingParams - UnitTestingParams
# - Documentation - Documentation
# with: with:
# document: pyEDAA.ProjectModel document: ${{ inputs.documentation }}
# latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }} latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
# pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }} pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
PublishToGitHubPages: PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
@@ -392,7 +397,7 @@ jobs:
- UnitTesting - UnitTesting
- StaticTypeCheck - StaticTypeCheck
- Documentation - Documentation
# - PDFDocumentation - PDFDocumentation
- PublishTestResults - PublishTestResults
- PublishCoverageResults - PublishCoverageResults
- PublishToGitHubPages - PublishToGitHubPages

View File

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

View File

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

View File

@@ -6,13 +6,14 @@ on:
jobs: jobs:
SimplePackage: SimplePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@latex
with: with:
package_name: pyDummy package_name: pyDummy
codecov: true documentation: Actions
codacy: true codecov: true
dorny: true codacy: true
cleanup: false dorny: true
cleanup: false
secrets: secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}