More cross-references.

This commit is contained in:
Patrick Lehmann
2022-10-31 00:56:34 +01:00
parent 7ace9f065b
commit 9992109467
7 changed files with 29 additions and 20 deletions

View File

@@ -26,15 +26,14 @@ pyTooling Actions Documentation
**pyTooling Actions** are reusable steps and workflows for GitHub Actions easing the creation and maintenance of
workflows for Python projects on GitHub.
Introduction
************
GitHub Actions workflows, actions and documentation are mostly focused on JavaScript/TypeScript as the scripting
language for writing reusable CI code.
However, Python being equally popular and capable, usage of JS/TS might be bypassed, with some caveats.
This repository gathers reusable CI tooling for testing, packaging and distributing Python projects and documentation.
Introduction
************
GitHub Action Job Templates
***************************
@@ -47,7 +46,7 @@ GitHub Action Job Templates
* :ref:`JOBTMPL/UnitTesting`
* :ref:`JOBTMPL/CodeCoverage`
* Static type checking
* :ref:`JOBTMPL/StaticTypeChecking`
**Build and Packaging**
@@ -55,15 +54,15 @@ GitHub Action Job Templates
**Documentation**
* Verify docs
* :ref:`JOBTMPL/VerifyDocumentation`
* :ref:`JOBTMPL/BuildTheDocs`
**Publishing**
* :ref:`JOBTMPL/GitHubReleasePage`
* :ref:`JOBTMPL/PyPI`
* Publish test results
* Publish to github pages
* :ref:`JOBTMPL/PublishTestResults`
* :ref:`JOBTMPL/PublishToGitHubPages`
**Cleanups**
@@ -115,6 +114,14 @@ License
\part{Main Documentation}
.. toctree::
:caption: Actions
:hidden:
Action/index
Action/Releaser
Action/With-post-step
.. toctree::
:caption: Job Templates
:hidden:
@@ -133,14 +140,6 @@ License
JobTemplate/Release
JobTemplate/ArtifactCleanUp
.. toctree::
:caption: Actions
:hidden:
Action/index
Action/Releaser
Action/With-post-step
.. raw:: latex
\part{Appendix}