pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-17 21:46:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fine tuning documentation pages.

Browse Source
This commit is contained in:
Patrick Lehmann
2025-09-09 07:48:42 +02:00
parent f37f087334
commit 57f88b158f
27 changed files with 368 additions and 648 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/JobTemplate/Documentation/LaTeXDocumentation.rst
View File

@@ -3,9 +3,11 @@
LatexDocumentation
##################
The ``LatexDocumentation`` job template ................
The ``LatexDocumentation`` job template downloads an artifact containing a LaTeX document and translates to a PDF file
using MikTeX.
* uses xelatex and latexmk
The translation process uses ``latexmk`` for handling multiple passes. The default LaTeX processor is ``xelatex``, but
can be switched by a parameter.
.. topic:: Features
@@ -13,12 +15,9 @@ The ``LatexDocumentation`` job template ................
.. topic:: Behavior
.. todo:: LatexDocumentation:Behavior needs documentation.
.. topic:: Job Execution
.. image:: ../../_static/pyTooling-Actions-LatexDocumentation.png
:width: 600px
1. Download the LaTeX artifact.
2. Build the PDF using ``latexmk``.
3. Upload the generated PDF as an artifact.
.. topic:: Dependencies
@@ -40,9 +39,6 @@ The ``LatexDocumentation`` job template ................
Instantiation
*************
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r5``. It only
requires a `name` parameter to create the artifact names.
.. code-block:: yaml
name: Pipeline
@@ -77,11 +73,6 @@ requires a `name` parameter to create the artifact names.
pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
.. seealso::
:ref:`JOBTMPL/TagReleaseCommit`
``LatexDocumentation`` is usualy
.. _JOBTMPL/LatexDocumentation/Parameters:
Parameter Summary