Documented PublishToGitHubPages.

doc/JobTemplate/BuildTheDocs.rst

@@ -46,8 +46,8 @@ Complex Example
          artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
 
 
-Template Parameters
-*******************
+Parameters
+**********
 
 artifact
 ========

doc/JobTemplate/PublishTestResults.rst

@@ -54,8 +54,8 @@ Complex Example
          - CodeCoverage
          - UnitTesting
 
-Template Parameters
-*******************
+Parameters
+**********
 
 report_files
 ============

doc/JobTemplate/PublishToGitHubPages.rst

@@ -3,6 +3,8 @@
 PublishToGitHubPages
 ####################
 
+This job publishes HTML content from artifacts of other jobs to GitHub Pages.
+
 Instantiation
 *************
 
@@ -11,31 +13,80 @@ Simple Example
 
 .. code-block:: yaml
 
-   TBD
+   jobs:
+     BuildTheDocs:
+       # ...
+
+     PublishToGitHubPages:
+       uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
+       needs:
+         - BuildTheDocs
+       with:
+         doc: Documentation
+
 
 Complex Example
 ===============
 
-
-
 .. code-block:: yaml
 
-   TBD
+   jobs:
+     PublishToGitHubPages:
+       uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
+       needs:
+         - Params
+         - BuildTheDocs
+         - Coverage
+         - StaticTypeCheck
+       with:
+         doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+         coverage: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
+         typing: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
 
-Template Parameters
-*******************
+Parameters
+**********
 
-TBD 1
-=====
+doc
+===
 
-TBD
+Name of the documentation artifact.
 
-TBD 1
-=====
++----------+----------+--------------+
+| Required | Type     | Default      |
++==========+==========+==============+
+| yes      | string   | — — — —      |
++----------+----------+--------------+
 
-TBD
+coverage
+========
 
-Template Results
-****************
+Name of the coverage artifact.
 
-*None*
++----------+----------+-----------------+
+| Required | Type     | Default         |
++==========+==========+=================+
+| optional | string   | ``""``          |
++----------+----------+-----------------+
+
+
+typing
+======
+
+Name of the typing artifact.
+
++----------+----------+-----------------+
+| Required | Type     | Default         |
++==========+==========+=================+
+| optional | string   | ``""``          |
++----------+----------+-----------------+
+
+
+Secrets
+*******
+
+This job template needs no secrets.
+
+Results
+*******
+
+This job template has no output parameters.

doc/JobTemplate/Release.rst

@@ -24,8 +24,8 @@ Complex Example
 
    TBD
 
-Template Parameters
-*******************
+Parameters
+**********
 
 TBD 1
 =====

doc/JobTemplate/VerifyDocs.rst

@@ -24,8 +24,8 @@ Complex Example
 
    TBD
 
-Template Parameters
-*******************
+Parameters
+**********
 
 TBD 1
 =====