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

@@ -42,28 +42,9 @@ the installation is verified. This aims for packaging and dependency mistakes in
Instantiation
*************
The following instantiation example creates a ``Params`` job derived from job template ``Parameters`` version ``@r5``. It only
requires a `name` parameter to create the artifact names.
.. todo::
.. code-block:: yaml
name: Pipeline
on:
push:
workflow_dispatch:
jobs:
Params:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r5
with:
name: pyTooling
.. seealso::
:ref:`JOBTMPL/Package`
``InstallPackage`` is usualy
InstallPackage:: Needs instantiation instructions.
.. _JOBTMPL/InstallPackage/Parameters:
@@ -73,11 +54,9 @@ Parameter Summary
.. rubric:: Goto :ref:`input parameters <JOBTMPL/InstallPackage/Inputs>`
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
| Parameter Name | Required | Type | Default |
+=====================================================================+==========+==========+===================================================================+
| :ref:`JOBTMPL/InstallPackage/Input/ubuntu_image` | no | string | ``'ubuntu-24.04'`` |
+---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
.. todo::
InstallPackage:: Needs a parameter list.
.. rubric:: Goto :ref:`secrets <JOBTMPL/InstallPackage/Secrets>`
@@ -93,10 +72,9 @@ This job template has no output parameters.
Input Parameters
****************
.. _JOBTMPL/InstallPackage/Input/ubuntu_image:
.. todo::
ubuntu_image
============
InstallPackage:: Needs input parameter descriptions.
.. _JOBTMPL/InstallPackage/Secrets:

View File

@@ -24,7 +24,6 @@ as an artifact.
* If parameter :ref:`JOBTMPL/Package/Input/requirements` is non-empty, use :pypi:`setuptools` for package and
execute ``python setup.py ...``.
.. topic:: Job Execution
.. image:: ../../_static/pyTooling-Actions-Package.png
@@ -77,11 +76,6 @@ Complex Example
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
.. seealso::
:ref:`JOBTMPL/PublishOnPyPI`
.. _JOBTMPL/Package/Parameters:
Parameter Summary

View File

@@ -5,9 +5,9 @@ Packaging
The category *packaging* provides workflow templates implementing
* :ref:`JOBTMPL/Package` -
* :ref:`JOBTMPL/InstallPackage` -
* :ref:`JOBTMPL/PublishOnPyPI` -
* :ref:`JOBTMPL/Package` - Package Python packages and modules as wheel.
* :ref:`JOBTMPL/InstallPackage` - Install Python package (wheel) on target platforms.
* :ref:`JOBTMPL/PublishOnPyPI` - Upload Python package (wheel) to PyPI.
.. toctree::
:hidden: