Documented BuildTheDocs.

doc/JobTemplate/BuildTheDocs.rst

@@ -3,6 +3,21 @@
 BuildTheDocs
 ############
 
+This jobs compiles the documentation written in ReStructured Text with Sphinx using BuildTheDocs.
+
+**Behavior:**
+
+1. Checkout repository.
+2. Build the documentation.
+3. Upload the HTML documentation as an artifact.
+
+**Dependencies:**
+
+* :gh:`actions/checkout`
+* :gh:`buildthedocs/btd`
+* :gh:`actions/upload-artifact`
+
+
 Instantiation
 *************
 
@@ -11,31 +26,46 @@ Simple Example
 
 .. code-block:: yaml
 
-   TBD
+   jobs:
+     BuildTheDocs:
+       uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
+       with:
+         artifact: Documentation
 
 Complex Example
 ===============
 
-
-
 .. code-block:: yaml
 
-   TBD
+   jobs:
+     BuildTheDocs:
+       uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
+       needs:
+         - Params
+       with:
+         artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+
 
 Template Parameters
 *******************
 
-TBD 1
-=====
+artifact
+========
 
-TBD
+Name of the documentation artifact.
 
-TBD 1
-=====
++----------+----------+--------------+
+| Required | Type     | Default      |
++==========+==========+==============+
+| yes      | string   | — — — —      |
++----------+----------+--------------+
 
-TBD
+Secrets
+*******
 
-Template Results
-****************
+This job template needs no secrets.
 
-*None*
+Results
+*******
+
+This job template has no output parameters.