Fine tuning documentation pages.

This commit is contained in:
Patrick Lehmann
2025-09-09 07:48:42 +02:00
parent f37f087334
commit 57f88b158f
27 changed files with 368 additions and 648 deletions

View File

@@ -116,12 +116,6 @@ The following
CODACY_TOKEN: ${{ secrets.CODACY_TOKEN }}
.. seealso::
:ref:`JOBTMPL/UnitTesting`
``UnitTesting`` is usualy
.. _JOBTMPL/PublishCoverageResults/Parameters:
Parameter Summary

View File

@@ -8,7 +8,7 @@ JUnit test summary reports to multiple services for visualization and longterm s
Supported services are:
* GitHub Actions - Job results using :gh:`dorny/test-reporter`
* GitHub Actions job results using :gh:`dorny/test-reporter`
* `Codecov <https://about.codecov.io/>`__
.. topic:: Features
@@ -99,13 +99,6 @@ Complex Example
- CodeCoverage
- UnitTesting
.. seealso::
:ref:`JOBTMPL/UnitTesting`
tbd
:ref:`JOBTMPL/PublishCoverageResults`
tbd
.. _JOBTMPL/PublishTestResults/Parameters:
@@ -343,5 +336,3 @@ Optimizations
*************
This template offers no optimizations (reduced job runtime).
merged_junit_artifact

View File

@@ -1,106 +0,0 @@
.. _JOBTMPL/PublishToGitHubPages:
PublishToGitHubPages
####################
This job publishes HTML content from artifacts of other jobs to GitHub Pages.
**Behavior:**
1. Checkout repository.
2. Download artifacts.
3. Push HTML files to branch ``gh-pages``.
**Dependencies:**
* :gh:`actions/checkout`
* :gh:`actions/download-artifact`
Instantiation
*************
Simple Example
==============
.. code-block:: yaml
jobs:
BuildTheDocs:
# ...
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
needs:
- BuildTheDocs
with:
doc: Documentation
Complex Example
===============
.. code-block:: yaml
jobs:
PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
needs:
- Params
- BuildTheDocs
- Coverage
- StaticTypeCheck
with:
doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
Parameters
**********
doc
===
+----------------+----------+----------+--------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+==============+
| doc | yes | string | — — — — |
+----------------+----------+----------+--------------+
Name of the documentation artifact.
coverage
========
+----------------+----------+----------+-----------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================+
| coverage | optional | string | ``""`` |
+----------------+----------+----------+-----------------+
Name of the coverage artifact.
typing
======
+----------------+----------+----------+-----------------+
| Parameter Name | Required | Type | Default |
+================+==========+==========+=================+
| typing | optional | string | ``""`` |
+----------------+----------+----------+-----------------+
Name of the typing artifact.
Secrets
*******
This job template needs no secrets.
Results
*******
This job template has no output parameters.

View File

@@ -7,11 +7,9 @@ The category *publish* provides workflow templates implementing
* :ref:`JOBTMPL/PublishTestResults` -
* :ref:`JOBTMPL/PublishCoverageResults` -
* :ref:`JOBTMPL/PublishToGitHubPages` -
.. toctree::
:hidden:
PublishTestResults
PublishCoverageResults
PublishToGitHubPages