Adjusted documentation to latest changes.

This commit is contained in:
Patrick Lehmann
2022-11-06 22:23:31 +01:00
parent e9e62c5ef6
commit 674b4ed239
8 changed files with 21 additions and 19 deletions

View File

@@ -10,6 +10,7 @@ This jobs compiles the documentation written in ReStructured Text with Sphinx us
1. Checkout repository.
2. Build the documentation.
3. Upload the HTML documentation as an artifact.
4. Publish the HTML documentation to GitHub Pages.
**Dependencies:**
@@ -18,6 +19,7 @@ This jobs compiles the documentation written in ReStructured Text with Sphinx us
* :gh:`actions/upload-artifact`
Instantiation
*************
@@ -29,8 +31,7 @@ Simple Example
jobs:
BuildTheDocs:
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
with:
artifact: Documentation
Complex Example
===============
@@ -43,7 +44,7 @@ Complex Example
needs:
- Params
with:
artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
Parameters
@@ -55,11 +56,13 @@ artifact
+----------------+----------+----------+--------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+==============+
| artifact | yes | string | — — — — |
| artifact | optional | string | ``""`` |
+----------------+----------+----------+--------------+
Name of the documentation artifact.
If no artifact name is given, the job directly publishes the documentation's HTML content to GitHub Pages.
Secrets
*******