Document all recently added workflow templates.

This commit is contained in:
Patrick Lehmann
2025-08-18 23:24:05 +02:00
parent c78cb4062f
commit a2db5ec238
32 changed files with 651 additions and 83 deletions

View File

@@ -0,0 +1,22 @@
.. _JOBTMPL/CheckDocumentation:
CheckDocumentation
##################
.. todo:: CheckDocumentation:Behavior needs documentation.
**Behavior:**
.. todo:: CheckDocumentation:Behavior needs documentation.
**Dependencies:**
.. todo:: CheckDocumentation:Dependencies needs documentation.
Instantiation
*************
Simple Example
==============
.. todo:: CheckDocumentation:Simple example needs documentation.

View File

@@ -0,0 +1,22 @@
.. _JOBTMPL/LatexDocumentation:
LatexDocumentation
##################
.. todo:: LatexDocumentation:Needs documentation.
**Behavior:**
.. todo:: LatexDocumentation:Behavior needs documentation.
**Dependencies:**
.. todo:: LatexDocumentation:Dependencies needs documentation.
Instantiation
*************
Simple Example
==============
.. todo:: LatexDocumentation:Simple example needs documentation.

View File

@@ -0,0 +1,22 @@
.. _JOBTMPL/SphinxDocumentation:
SphinxDocumentation
###################
.. todo:: SphinxDocumentation:Needs documentation.
**Behavior:**
.. todo:: SphinxDocumentation:Behavior needs documentation.
**Dependencies:**
.. todo:: SphinxDocumentation:Dependencies needs documentation.
Instantiation
*************
Simple Example
==============
.. todo:: SphinxDocumentation:Simple example needs documentation.

View File

@@ -0,0 +1,42 @@
.. _JOBTMPL/VerifyDocs:
VerifyDocs
##########
This job extracts code examples from the README and tests these code snippets.
**Behavior:**
TBD
**Dependencies:**
TBD
Instantiation
*************
Simple Example
==============
.. todo:: VerifyDocs:SimpleExample Needs documentation.
Complex Example
===============
.. todo:: VerifyDocs:ComplexExample Needs documentation.
Parameters
**********
.. todo:: VerifyDocs:Parameters Needs documentation.
Secrets
*******
This job template needs no secrets.
Results
*******
This job template has no output parameters.

View File

@@ -0,0 +1,15 @@
.. _JOBTMPL/Documentation:
Documentation
#############
The category *documentation* provides workflow templates implementing
.. toctree::
:hidden:
VerifyDocs
CheckDocumentation
LaTeXDocumentation
SphinxDocumentation