LaTeXDocumentation

The LaTeXDocumentation job template downloads an artifact containing a LaTeX document and translates to a PDF file using MikTeX.

The translation process uses latexmk for handling multiple passes. The default LaTeX processor is xelatex, but can be switched by a parameter.

Instantiation

jobs:
  UnitTestingParams:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r6
    with:
      package_name: myPackage

  Documentation:
    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
    needs:
      - UnitTestingParams
    with:
      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
      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@r6
    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 }}

Parameter Summary

Goto input parameters

Parameter Name	Required	Type	Default
ubuntu_image_version	no	string	`'24.04'`
latex_artifact	yes	string	— — — —
document	yes	string	— — — —
processor	no	string	`'xelatex'`
pdf_artifact	no	string	`''`

Goto secrets

This job template needs no secrets.

Goto output parameters

This job template has no output parameters.

Input Parameters

ubuntu_image_version

Type:: string
Required:: no
Default Value:: '24.04'
Possible Values:: See actions/runner-images - Available Images for available Ubuntu image versions.
Description:: Version of the Ubuntu image used to run the job.

Note

Unfortunately, GitHub Actions has only a limited set of functions, thus, the usual Ubuntu image name like 'ubuntu-24.04' can’t be split into image name and image version.

latex_artifact

Type:: string
Required:: yes
Default Value:: — — — —
Possible Values:: Any valid artifact name.
Description:: Name of the artifact containing the LaTeX document to translate.

document

Type:: string
Required:: yes
Default Value:: — — — —
Possible Values:: Any valid document name.
Description:: Name of the LaTeX document

processor

Type:: string
Required:: no
Default Value:: 'xelatex'
Possible Values:: Any supported LaTeX processor supported by MikTeX and latexmk.
Description:: Name of the used LaTeX processor.

pdf_artifact

Type:: string
Required:: no
Default Value:: ''
Possible Values:: Any valid artifact name.
Description:: Name of the artifact containing the generated PDF document.
Optimization:: Hint

If this parameter is empty, no PDF file will be generated and no artifact will be uploaded.

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.

Optimizations

The following optimizations can be used to reduce the template’s runtime.

Disable PDF generation and PDF artifact: If parameter pdf_artifact is empty, no PDF will be generated and uploaded.