diff --git a/doc/JobTemplate/ArtifactCleanUp.rst b/doc/JobTemplate/ArtifactCleanUp.rst index 78b8fb3..f9a2fe7 100644 --- a/doc/JobTemplate/ArtifactCleanUp.rst +++ b/doc/JobTemplate/ArtifactCleanUp.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/ArtifactCleanup: + ArtifactCleanUp ############### diff --git a/doc/JobTemplate/BuildTheDocs.rst b/doc/JobTemplate/BuildTheDocs.rst index 20318b4..73f242c 100644 --- a/doc/JobTemplate/BuildTheDocs.rst +++ b/doc/JobTemplate/BuildTheDocs.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/BuildTheDocs: + BuildTheDocs ############ diff --git a/doc/JobTemplate/CoverageCollection.rst b/doc/JobTemplate/CoverageCollection.rst index 975f333..973b348 100644 --- a/doc/JobTemplate/CoverageCollection.rst +++ b/doc/JobTemplate/CoverageCollection.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/CodeCoverage: + CoverageCollection ################## diff --git a/doc/JobTemplate/Package.rst b/doc/JobTemplate/Package.rst index bdf4f8d..416a391 100644 --- a/doc/JobTemplate/Package.rst +++ b/doc/JobTemplate/Package.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/Package: + Package ####### diff --git a/doc/JobTemplate/Parameters.rst b/doc/JobTemplate/Parameters.rst index e2a714c..2ff0d4e 100644 --- a/doc/JobTemplate/Parameters.rst +++ b/doc/JobTemplate/Parameters.rst @@ -1,8 +1,10 @@ +.. _JOBTMPL/Parameters: + Parameters ########## -The `Parameters` job template is a workaround for the limitations of GitHub Actions to handle global variables in -GitHub Actions workflows (see [actions/runner#480](https://github.com/actions/runner/issues/480)). +The ``Parameters`` job template is a workaround for the limitations of GitHub Actions to handle global variables in +GitHub Actions workflows (see `actions/runner#480 `__. It generates output parameters with artifact names and a job matrix to be used in later running jobs. diff --git a/doc/JobTemplate/PublishOnPyPI.rst b/doc/JobTemplate/PublishOnPyPI.rst index 00d0ee5..ed5654d 100644 --- a/doc/JobTemplate/PublishOnPyPI.rst +++ b/doc/JobTemplate/PublishOnPyPI.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/PyPI: + PublishOnPyPI ############# diff --git a/doc/JobTemplate/UnitTesting.rst b/doc/JobTemplate/UnitTesting.rst index 50dc15b..c0d8af5 100644 --- a/doc/JobTemplate/UnitTesting.rst +++ b/doc/JobTemplate/UnitTesting.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/UnitTesting: + UnitTesting ########### @@ -67,11 +69,11 @@ requirements Python dependencies to be installed through pip. -+----------+----------+----------+ -| Required | Type | Default | -+==========+==========+==========+ ++----------+----------+---------------------------------+ +| Required | Type | Default | ++==========+==========+=================================+ | optional | string | ``-r tests/requirements.txt`` | -+----------+----------+----------+ ++----------+----------+---------------------------------+ pacboy diff --git a/doc/JobTemplate/index.rst b/doc/JobTemplate/index.rst index be86e43..b20492f 100644 --- a/doc/JobTemplate/index.rst +++ b/doc/JobTemplate/index.rst @@ -1,4 +1,32 @@ Overview ######## +**Global Templates** +* :ref:`JOBTMPL/Parameters` + +**Unit Tests, Code Coverage, ...** + +* :ref:`JOBTMPL/UnitTesting` +* :ref:`JOBTMPL/CodeCoverage` +* Static type checking + +**Build and Packaging** + +* :ref:`JOBTMPL/Package` + +**Documentation** + +* Verify docs +* :ref:`JOBTMPL/BuildTheDocs` + +**Publishing** + +* :ref:`JOBTMPL/GitHubReleasePage` +* :ref:`JOBTMPL/PyPI` +* Publish test results +* Publish to github pages + +**Cleanups** + +* :ref:`JOBTMPL/ArtifactCleanup` diff --git a/doc/index.rst b/doc/index.rst index 8cfc23d..32824e5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -36,8 +36,42 @@ Introduction -Package Details -*************** +GitHub Action Job Templates +*************************** + +**Global Templates** + +* :ref:`JOBTMPL/Parameters` + +**Unit Tests, Code Coverage, ...** + +* :ref:`JOBTMPL/UnitTesting` +* :ref:`JOBTMPL/CodeCoverage` +* Static type checking + +**Build and Packaging** + +* :ref:`JOBTMPL/Package` + +**Documentation** + +* Verify docs +* :ref:`JOBTMPL/BuildTheDocs` + +**Publishing** + +* :ref:`JOBTMPL/GitHubReleasePage` +* :ref:`JOBTMPL/PyPI` +* Publish test results +* Publish to github pages + +**Cleanups** + +* :ref:`JOBTMPL/ArtifactCleanup` + + +GitHub Actions +************** Contributors