Restructured chapters.

doc/JobTemplate/Documentation/index.rst

@@ -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

doc/JobTemplate/Package/index.rst

@@ -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

doc/JobTemplate/Publish/index.rst

@@ -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

doc/JobTemplate/Quality/CheckDocumentation.rst

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

doc/JobTemplate/Quality/StaticTypeCheck.rst

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

doc/JobTemplate/Quality/index.rst

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

doc/JobTemplate/Release/index.rst

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

doc/JobTemplate/Testing/ApplicationTesting.rst

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

doc/JobTemplate/Testing/index.rst

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

doc/JobTemplate/index.rst

@@ -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)*

doc/index.rst

@@ -35,6 +35,13 @@ However, Python being equally popular and capable, usage of JS/TS might be bypas
 This repository gathers reusable CI tooling for testing, packaging and distributing Python projects and documentation.
 
 
+GitHub Actions
+**************
+
+* :ref:`ACTION/Releaser`
+* :ref:`ACTION/WithPostStep`
+
+
 GitHub Action Job Templates
 ***************************
 
@@ -76,7 +83,7 @@ Workflow):
 
       .. rubric:: Code Quality
 
-      * :ref:`JOBTMPL/StaticTypeChecking`
+      * :ref:`JOBTMPL/StaticTypeCheck`
       * *code formatting (planned)*
       * *coding style (planned)*
       * *code linting (planned)*
@@ -122,19 +129,78 @@ Workflow):
 Example Pipelines
 =================
 
-``ExamplePipeline.yml`` is an example Workflow which uses all of the Reusable Workflows.
+.. grid:: 2
-Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway.
-Minimal required modifications are the following:
 
-- Set the ``name`` input of job ``Parameters``.
+   .. grid-item::
-- Specify the ``commands`` input of job ``StaticTypeCheck``.
+      :columns: 6
 
+      ``ExamplePipeline.yml`` is an example Workflow which uses all of the Reusable Workflows.
+      Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway.
+      Minimal required modifications are the following:
 
-GitHub Actions
+      * Set the ``name`` input of job ``Parameters``.
-**************
+      * Specify the ``commands`` input of job ``StaticTypeCheck``.
+
+   .. grid-item::
+      :columns: 6
+
+      .. tab-set::
+
+         .. tab-item:: Simple Package
+
+            .. code-block:: yaml
+
+               name: Pipeline
+
+               on:
+                 push:
+                 workflow_dispatch:
+                 schedule:
+               # Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
+                   - cron: '0 22 * * 5'
+
+               jobs:
+                 SimplePackage:
+                   uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
+                   with:
+                     package_name: myPackage
+                     codecov:      true
+                     codacy:       true
+                     dorny:        true
+                   secrets:
+                     PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
+                     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+                     CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}
+
+         .. tab-item:: Namespace Package
+
+            .. code-block:: yaml
+
+               name: Pipeline
+
+               on:
+                 push:
+                 workflow_dispatch:
+                 schedule:
+               # Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
+                   - cron: '0 22 * * 5'
+
+               jobs:
+                 NamespacePackage:
+                   uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
+                   with:
+                     package_namespace: myFramework
+                     package_name:      Extension
+                     codecov:           true
+                     codacy:            true
+                     dorny:             true
+                   secrets:
+                     PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
+                     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+                     CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}
+
+.. image:: _static/pyTooling-Actions-SimplePackage.png
 
-* :ref:`ACTION/Releaser`
-* :ref:`ACTION/WithPostStep`
 
 References
 **********
@@ -199,17 +265,11 @@ License
    JobTemplate/AllInOne/index
    JobTemplate/Global/index
    JobTemplate/Documentation/index
-   JobTemplate/UnitTesting
+   JobTemplate/Testing/index
-   JobTemplate/ApplicationTesting
+   JobTemplate/Quality/index
-   JobTemplate/StaticTypeCheck
+   JobTemplate/Package/index
-   JobTemplate/PublishTestResults
+   JobTemplate/Publish/index
-   JobTemplate/PublishCoverageResults
+   JobTemplate/Release/index
-   JobTemplate/Package
-   JobTemplate/InstallPackage
-   JobTemplate/PublishOnPyPI
-   JobTemplate/PublishToGitHubPages
-   JobTemplate/TagReleaseCommit
-   JobTemplate/PublishReleaseNotes
    JobTemplate/Cleanup/index
    JobTemplate/Deprecated/index