Skip to content

Documentation rendered with pyTooling.Sphinx instead of sphinx-reports #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Paebbels merged 5 commits into from
Oct 11, 2026
Merged

Documentation rendered with pyTooling.Sphinx instead of sphinx-reports #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2bbb49f
Render the documentation with pyTooling.Sphinx instead of sphinx_reports
claude-code Oct 9, 2026
81659d7
LaTeX: allow lists nested deeper than 4 levels
claude-code Oct 9, 2026
ae7d0c9
Directory structures as a 'tree' instead of indented text
claude-code Oct 9, 2026
0de1be8
CompletePipeline: the hierarchy of workflows and actions as a 'tree'
claude-code Oct 9, 2026
1ec86e5
Hierarchies in the documentation drawn by the 'tree' directive (#298)
Paebbels Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/CodeCoverage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Code Coverage Report

Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__,
`Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__ and visualized by
`sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.
`pyTooling.Sphinx <https://github.com/pyTooling/pyTooling.Sphinx>`__.
2 changes: 1 addition & 1 deletion doc/DocCoverage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Documentation Coverage Report
----------

Documentation coverage generated with `"""docstr-coverage""" <https://github.com/HunterMcGushion/docstr_coverage>`__ and
visualized by `sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.
visualized by `pyTooling.Sphinx <https://github.com/pyTooling/pyTooling.Sphinx>`__.
207 changes: 171 additions & 36 deletions doc/JobTemplate/AllInOne/CompletePipeline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,126 @@ It can be used for simple Python packages as well as namespace packages.

.. image:: ../../_static/pyTooling-Actions-SimplePackage.png

.. topic:: Workflow Hierarchy

The jobs of :file:`CompletePipeline.yml` in job order, each with the reusable workflow it calls, and the actions
that workflow uses: 📄 a workflow, 🧩 a composite action with the actions it uses, 🔗 a third-party action, 🐳 a
container image.

.. tree::
:root-icon: 📄
:node-icon: 📄
:leaf-icon: 📄
:icons: + 🧩, > 🔗, = 🐳
:expanded-levels: 1

- :file:`CompletePipeline.yml`
- :ref:`PrepareJob.yml <JOBTMPL/PrepareJob>` | job ``Prepare``
> :gh:`actions/checkout@v7 <actions/checkout>`
- :ref:`ExtractConfiguration.yml <JOBTMPL/ExtractConfiguration>` | job ``ConfigParams``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`Parameters.yml <JOBTMPL/Parameters>` | job ``UnitTestingParams``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`Parameters.yml <JOBTMPL/Parameters>` | job ``AppTestingParams``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`Parameters.yml <JOBTMPL/Parameters>` | job ``InstallParams``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`CheckReleaseVersion.yml <JOBTMPL/CheckReleaseVersion>` | job ``VersionCheck``
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`UnitTesting.yml <JOBTMPL/UnitTesting>` | job ``UnitTesting``
> :gh:`actions/checkout@v7 <actions/checkout>`
+ :ghsrc:`ComputeRequirements <.github/actions/ComputeRequirements>` | Compute paths to requirements files
+ :ghsrc:`ComputePacboyPackages <.github/actions/ComputePacboyPackages>` | Compute pacman/pacboy packages
> :gh:`msys2/setup-msys2@v2 <msys2/setup-msys2>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`StaticTypeCheck.yml <JOBTMPL/StaticTypeCheck>` | job ``StaticTypeCheck``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
+ :ghsrc:`ComputeRequirements <.github/actions/ComputeRequirements>` | Compute paths to requirements files
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`CheckCodeQuality.yml <JOBTMPL/CheckCodeQuality>` | job ``CodeQuality``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
> :gh:`dorny/test-reporter@v3 <dorny/test-reporter>`
- :ref:`CheckDocumentation.yml <JOBTMPL/CheckDocumentation>` | job ``DocCoverage``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`Package.yml <JOBTMPL/Package>` | job ``Package``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`InstallPackage.yml <JOBTMPL/InstallPackage>` | job ``Install``
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
> :gh:`msys2/setup-msys2@v2 <msys2/setup-msys2>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
- :ref:`ApplicationTesting.yml <JOBTMPL/ApplicationTesting>` | job ``AppTesting``
> :gh:`actions/checkout@v7 <actions/checkout>`
+ :ghsrc:`ComputeRequirements <.github/actions/ComputeRequirements>` | Compute paths to requirements files
+ :ghsrc:`ComputePacboyPackages <.github/actions/ComputePacboyPackages>` | Compute pacman/pacboy packages
> :gh:`msys2/setup-msys2@v2 <msys2/setup-msys2>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`PublishCoverageResults.yml <JOBTMPL/PublishCoverageResults>` | job ``PublishCoverageResults``
> :gh:`actions/checkout@v7 <actions/checkout>`
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
> :gh:`codecov/codecov-action@v7 <codecov/codecov-action>`
> :gh:`codacy/codacy-coverage-reporter-action@v1 <codacy/codacy-coverage-reporter-action>`
- :ref:`PublishTestResults.yml <JOBTMPL/PublishTestResults>` | job ``PublishTestResults``
> :gh:`actions/checkout@v7 <actions/checkout>`
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
> :gh:`dorny/test-reporter@v3 <dorny/test-reporter>`
> :gh:`codecov/codecov-action@v7 <codecov/codecov-action>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`SphinxDocumentation.yml <JOBTMPL/SphinxDocumentation>` | job ``Documentation``
> :gh:`actions/checkout@v7 <actions/checkout>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`CleanupArtifacts.yml <JOBTMPL/CleanupArtifacts>` | job ``IntermediateCleanUp``
> :gh:`geekyeggo/delete-artifact@v6 <geekyeggo/delete-artifact>`
- :ref:`LaTeXDocumentation.yml <JOBTMPL/LaTeXDocumentation>` | job ``PDFDocumentation``
= :dockerhub:`pytooling/miktex:sphinx <pytooling/miktex>` | container image
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
+ :gh:`pyTooling/upload-artifact@v7 <pyTooling/upload-artifact>`
> :gh:`actions/upload-artifact@v7 <actions/upload-artifact>`
- :ref:`PublishToGitHubPages.yml <JOBTMPL/PublishToGitHubPages>` | job ``PublishToGitHubPages``
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
> :gh:`geekyeggo/delete-artifact@v6 <geekyeggo/delete-artifact>`
> :gh:`actions/upload-pages-artifact@v5 <actions/upload-pages-artifact>`
> :gh:`actions/deploy-pages@v5 <actions/deploy-pages>`
- :ref:`TagReleaseCommit.yml <JOBTMPL/TagReleaseCommit>` | job ``TriggerTaggedRelease``
> :gh:`actions/github-script@v9 <actions/github-script>`
- :ref:`PublishReleaseNotes.yml <JOBTMPL/PublishReleaseNotes>` | job ``ReleasePage``
> :gh:`actions/checkout@v7 <actions/checkout>`
- :ref:`PublishOnPyPI.yml <JOBTMPL/PublishOnPyPI>` | job ``PublishOnPyPI``
+ :gh:`pyTooling/download-artifact@v8 <pyTooling/download-artifact>`
> :gh:`actions/download-artifact@v8 <actions/download-artifact>`
> :gh:`actions/setup-python@v7 <actions/setup-python>`
> :gh:`geekyeggo/delete-artifact@v6 <geekyeggo/delete-artifact>`
- :ref:`CleanupArtifacts.yml <JOBTMPL/CleanupArtifacts>` | job ``ArtifactCleanUp``
> :gh:`geekyeggo/delete-artifact@v6 <geekyeggo/delete-artifact>`

.. topic:: Dependencies

.. dropdown:: Expand List
Expand Down Expand Up @@ -386,31 +506,38 @@ version ``@r8``. It only requires the `package_name` parameter to run a full pip
.. tab-item:: Simple Package
:sync: Simple

.. code-block::

📂ProjectRoot/
📂myFramework/
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
- :file:`ProjectRoot/`
- :file:`myFramework/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. tab-item:: Namespace Package
:sync: Namespace

.. code-block::
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

📂ProjectRoot/
📂myFramework/
📂Extension/
📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
- :file:`ProjectRoot/`
- :file:`myFramework/`
- :file:`Extension/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. _JOBTMPL/CompletePipeline/Parameters:
Expand Down Expand Up @@ -549,16 +676,20 @@ package_namespace

.. rubric:: Example Directory Structure

.. code-block::
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

📂ProjectRoot/
📂myFramework/
📂Extension/
📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
- :file:`ProjectRoot/`
- :file:`myFramework/`
- :file:`Extension/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. _JOBTMPL/CompletePipeline/Input/package_name:
Expand Down Expand Up @@ -596,15 +727,19 @@ package_name

.. rubric:: Example Directory Structure

.. code-block::

📂ProjectRoot/
📂myFramework/
📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

- :file:`ProjectRoot/`
- :file:`myFramework/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. _JOBTMPL/CompletePipeline/Input/version_file:
Expand Down
46 changes: 27 additions & 19 deletions doc/JobTemplate/Setup/Parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,16 +310,20 @@ package_namespace

.. rubric:: Example Directory Structure

.. code-block::

📂ProjectRoot/
📂myFramework/
📂Extension/
📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

- :file:`ProjectRoot/`
- :file:`myFramework/`
- :file:`Extension/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. _JOBTMPL/Parameters/Input/package_name:
Expand Down Expand Up @@ -358,15 +362,19 @@ package_name

.. rubric:: Example Directory Structure

.. code-block::

📂ProjectRoot/
📂myFramework/
📦SubPackage/
🐍__init__.py
🐍SubModuleA.py
🐍__init__.py
🐍ModuleB.py
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: * 📦

- :file:`ProjectRoot/`
- :file:`myFramework/`
* :file:`SubPackage/`
- :file:`__init__.py`
- :file:`SubModuleA.py`
- :file:`__init__.py`
- :file:`ModuleB.py`


.. _JOBTMPL/Parameters/Input/python_version:
Expand Down
22 changes: 13 additions & 9 deletions doc/JobTemplate/Testing/UnitTesting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,15 +472,19 @@ ucrt64_before_script

.. card:: Directory Structure

.. code-block::

<RepositoryRoot>/
doc/
myPackage/
__init__.py
tests/
unit/
myTests.py
.. tree::
:root-icon: 📂
:node-icon: 📂
:leaf-icon: 🐍
:icons: > 📂

- :file:`<RepositoryRoot>/`
> :file:`doc/`
- :file:`myPackage/`
- :file:`__init__.py`
- :file:`tests/`
- :file:`unit/`
- :file:`myTests.py`

.. grid-item::
:columns: 3
Expand Down
Loading
Loading