mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Document all recently added workflow templates.
This commit is contained in:
22
doc/JobTemplate/Documentation/CheckDocumentation.rst
Normal file
22
doc/JobTemplate/Documentation/CheckDocumentation.rst
Normal 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.
|
||||
22
doc/JobTemplate/Documentation/LaTeXDocumentation.rst
Normal file
22
doc/JobTemplate/Documentation/LaTeXDocumentation.rst
Normal 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.
|
||||
22
doc/JobTemplate/Documentation/SphinxDocumentation.rst
Normal file
22
doc/JobTemplate/Documentation/SphinxDocumentation.rst
Normal 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.
|
||||
42
doc/JobTemplate/Documentation/VerifyDocs.rst
Normal file
42
doc/JobTemplate/Documentation/VerifyDocs.rst
Normal 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.
|
||||
15
doc/JobTemplate/Documentation/index.rst
Normal file
15
doc/JobTemplate/Documentation/index.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _JOBTMPL/Documentation:
|
||||
|
||||
Documentation
|
||||
#############
|
||||
|
||||
The category *documentation* provides workflow templates implementing
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
VerifyDocs
|
||||
CheckDocumentation
|
||||
LaTeXDocumentation
|
||||
SphinxDocumentation
|
||||
Reference in New Issue
Block a user