From 99921094676a589af3251504c95c0c27ed6741d9 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 31 Oct 2022 00:56:34 +0100 Subject: [PATCH] More cross-references. --- doc/JobTemplate/PublishTestResults.rst | 2 ++ doc/JobTemplate/PublishToGitHubPages.rst | 2 ++ doc/JobTemplate/Release.rst | 2 ++ doc/JobTemplate/StaticTypeCheck.rst | 2 ++ doc/JobTemplate/VerifyDocs.rst | 2 ++ doc/JobTemplate/index.rst | 8 +++--- doc/index.rst | 31 ++++++++++++------------ 7 files changed, 29 insertions(+), 20 deletions(-) diff --git a/doc/JobTemplate/PublishTestResults.rst b/doc/JobTemplate/PublishTestResults.rst index cfaaf2f..12b493e 100644 --- a/doc/JobTemplate/PublishTestResults.rst +++ b/doc/JobTemplate/PublishTestResults.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/PublishTestResults: + PublishTestResults ################## diff --git a/doc/JobTemplate/PublishToGitHubPages.rst b/doc/JobTemplate/PublishToGitHubPages.rst index bdb70ae..ec1571b 100644 --- a/doc/JobTemplate/PublishToGitHubPages.rst +++ b/doc/JobTemplate/PublishToGitHubPages.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/PublishToGitHubPages: + PublishToGitHubPages #################### diff --git a/doc/JobTemplate/Release.rst b/doc/JobTemplate/Release.rst index 0b28180..9b206b4 100644 --- a/doc/JobTemplate/Release.rst +++ b/doc/JobTemplate/Release.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/GitHubReleasePage: + Release ####### diff --git a/doc/JobTemplate/StaticTypeCheck.rst b/doc/JobTemplate/StaticTypeCheck.rst index d2a1cd1..a05bf56 100644 --- a/doc/JobTemplate/StaticTypeCheck.rst +++ b/doc/JobTemplate/StaticTypeCheck.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/StaticTypeChecking: + StaticTypeCheck ############### diff --git a/doc/JobTemplate/VerifyDocs.rst b/doc/JobTemplate/VerifyDocs.rst index d6a94f3..b5cd990 100644 --- a/doc/JobTemplate/VerifyDocs.rst +++ b/doc/JobTemplate/VerifyDocs.rst @@ -1,3 +1,5 @@ +.. _JOBTMPL/VerifyDocumentation: + VerifyDocs ########## diff --git a/doc/JobTemplate/index.rst b/doc/JobTemplate/index.rst index b20492f..18503d5 100644 --- a/doc/JobTemplate/index.rst +++ b/doc/JobTemplate/index.rst @@ -9,7 +9,7 @@ Overview * :ref:`JOBTMPL/UnitTesting` * :ref:`JOBTMPL/CodeCoverage` -* Static type checking +* :ref:`JOBTMPL/StaticTypeChecking` **Build and Packaging** @@ -17,15 +17,15 @@ Overview **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** diff --git a/doc/index.rst b/doc/index.rst index 32824e5..4b40ad8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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}