pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-20 15:06:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

More cross-references.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/JobTemplate/PublishTestResults.rst
View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/PublishTestResults:
PublishTestResults PublishTestResults
################## ##################

2
doc/JobTemplate/PublishToGitHubPages.rst
View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/PublishToGitHubPages:
PublishToGitHubPages PublishToGitHubPages
#################### ####################

2
doc/JobTemplate/Release.rst
View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/GitHubReleasePage:
Release Release
####### #######

2
doc/JobTemplate/StaticTypeCheck.rst
View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/StaticTypeChecking:
StaticTypeCheck StaticTypeCheck
############### ###############

2
doc/JobTemplate/VerifyDocs.rst
View File

@@ -1,3 +1,5 @@
.. _JOBTMPL/VerifyDocumentation:
VerifyDocs VerifyDocs
########## ##########

8
doc/JobTemplate/index.rst
View File

@@ -9,7 +9,7 @@ Overview
* :ref:`JOBTMPL/UnitTesting` * :ref:`JOBTMPL/UnitTesting`
* :ref:`JOBTMPL/CodeCoverage` * :ref:`JOBTMPL/CodeCoverage`
* Static type checking * :ref:`JOBTMPL/StaticTypeChecking`
**Build and Packaging** **Build and Packaging**
@@ -17,15 +17,15 @@ Overview
**Documentation** **Documentation**
* Verify docs * :ref:`JOBTMPL/VerifyDocumentation`
* :ref:`JOBTMPL/BuildTheDocs` * :ref:`JOBTMPL/BuildTheDocs`
**Publishing** **Publishing**
* :ref:`JOBTMPL/GitHubReleasePage` * :ref:`JOBTMPL/GitHubReleasePage`
* :ref:`JOBTMPL/PyPI` * :ref:`JOBTMPL/PyPI`
* Publish test results * :ref:`JOBTMPL/PublishTestResults`
* Publish to github pages * :ref:`JOBTMPL/PublishToGitHubPages`
**Cleanups** **Cleanups**

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