Restructured chapters.

This commit is contained in:
Patrick Lehmann
2025-08-19 22:28:34 +02:00
parent 3141de852a
commit 4badbda8e7
20 changed files with 169 additions and 28 deletions

View File

@@ -5,11 +5,13 @@ Documentation
The category *documentation* provides workflow templates implementing
* :ref:`JOBTMPL/VerifyDocs` -
* :ref:`JOBTMPL/SphinxDocumentation` -
* :ref:`JOBTMPL/LaTeXDocumentation` -
.. toctree::
:hidden:
VerifyDocs
CheckDocumentation
LaTeXDocumentation
SphinxDocumentation
LaTeXDocumentation

View File

@@ -0,0 +1,17 @@
.. _JOBTMPL/Packaging:
Packaging
#########
The category *packaging* provides workflow templates implementing
* :ref:`JOBTMPL/Package` -
* :ref:`JOBTMPL/InstallPackage` -
* :ref:`JOBTMPL/PublishOnPyPI` -
.. toctree::
:hidden:
Package
InstallPackage
PublishOnPyPI

View File

@@ -19,4 +19,4 @@ Instantiation
Simple Example
==============
.. todo:: PublishCoverageResults:Simple example needs documentation.
.. todo:: PublishCoverageResults:Simple example needs documentation.

View File

@@ -0,0 +1,19 @@
.. _JOBTMPL/Publish:
Publish
#######
The category *publish* provides workflow templates implementing
* :ref:`JOBTMPL/PublishTestResults` -
* :ref:`JOBTMPL/PublishCoverageResults` -
* :ref:`JOBTMPL/PublishReleaseNotes` -
* :ref:`JOBTMPL/PublishToGitHubPages` -
.. toctree::
:hidden:
PublishTestResults
PublishCoverageResults
PublishReleaseNotes
PublishToGitHubPages

View File

@@ -3,7 +3,7 @@
CheckDocumentation
##################
.. todo:: CheckDocumentation:Behavior needs documentation.
.. todo:: CheckDocumentation:Needs documentation.
**Behavior:**

View File

@@ -1,4 +1,4 @@
.. _JOBTMPL/StaticTypeChecking:
.. _JOBTMPL/StaticTypeCheck:
StaticTypeCheck
###############

View File

@@ -0,0 +1,15 @@
.. _JOBTMPL/Quality:
Quality
#######
The category *quality* provides workflow templates implementing
* :ref:`JOBTMPL/CheckDocumentation` -
* :ref:`JOBTMPL/StaticTypeCheck` -
.. toctree::
:hidden:
StaticTypeCheck
CheckDocumentation

View File

@@ -0,0 +1,13 @@
.. _JOBTMPL/Release:
Release
#######
The category *release* provides workflow templates implementing
* :ref:`JOBTMPL/TagReleaseCommit` -
.. toctree::
:hidden:
TagReleaseCommit

View File

@@ -3,7 +3,7 @@
ApplicationTesting
##################
.. todo:: ApplicationTesting:Need introduction.
.. todo:: ApplicationTesting:Needs documentation.
**Behavior:**

View File

@@ -0,0 +1,15 @@
.. _JOBTMPL/Testing:
Testing
#######
The category *testing* provides workflow templates implementing
* :ref:`JOBTMPL/UnitTesting` -
* :ref:`JOBTMPL/ApplicationTesting` -
.. toctree::
:hidden:
UnitTesting
ApplicationTesting

View File

@@ -41,7 +41,7 @@ Workflow). They can also serve as an example for creating or deriving own job te
.. rubric:: Code Quality
* :ref:`JOBTMPL/StaticTypeChecking`
* :ref:`JOBTMPL/StaticTypeCheck`
* *code formatting (planned)*
* *coding style (planned)*
* *code linting (planned)*