Documentation fine-tuning.

2026-02-12 02:56:56 +08:00 · 2025-09-21 18:58:59 +02:00
parent fb67dd0fdb
commit b247eb4a53
28 changed files with 271 additions and 23 deletions
--- a/doc/JobTemplate/AllInOne/CompletePipeline.rst
+++ b/doc/JobTemplate/AllInOne/CompletePipeline.rst
@@ -1,4 +1,22 @@
 .. _JOBTMPL/CompletePipeline:
+.. index::
+   single: build; CompletePipeline Template
+   single: Bandit; CompletePipeline Template
+   single: CodeCov; CompletePipeline Template
+   single: Codacy; CompletePipeline Template
+   single: Coverage.py; CompletePipeline Template
+   single: docstr_coverage; CompletePipeline Template
+   single: GitHub Pages; CompletePipeline Template
+   single: interrogate; CompletePipeline Template
+   single: MikTeX; CompletePipeline Template
+   single: mypy; CompletePipeline Template
+   single: PyPI; CompletePipeline Template
+   single: pytest; CompletePipeline Template
+   single: pyEDAA.Reports; CompletePipeline Template
+   single: Sphinx; CompletePipeline Template
+   single: Test Reporter; CompletePipeline Template
+   single: twine; CompletePipeline Template
+   single: GitHub Action Reusable Workflow; CompletePipeline Template

 CompletePipeline
 ################
@@ -16,56 +34,57 @@ It can be used for simple Python packages as well as namespace packages.

         .. rubric:: Testing

-         * Run unit tests.
-         * Run platform tests.
-         * Run application tests on target platform.
+         * Run unit tests before packaging using :term:`pytest`.
+         * Run platform tests before packaging using :term:`pytest`.
+         * Run application tests using packaged code on target platform.

         .. rubric:: Code Quality

-         * Collect code coverage.
-         * Check documentation coverage.
-         * Check static typing closure.
+         * Collect code coverage using :term:`Coverage.py`.
+         * Check documentation coverage using :term:`docstr_coverage` and :term:`interrogate`.
+         * Check static typing closure using :term:`mypy`.
+         * Static Application Security Testing (SAST) using :term:`bandit`

         .. rubric:: Report Handling

-         * Merge unit test results into a single summary report.
-         * Merge code coverage results into a single summary report.
+         * Merge unit test results into one report using :term:`pyEDAA.Reports`.
+         * Merge code coverage results into one report using :term:`Coverage.py`.

      .. grid-item::
         :columns: 4

         .. rubric:: Documentation

-         * Compile documentation using Sphinx as HTML and LaTeX.
-         * Translate LaTeX documentation to PDF.
+         * Compile documentation using :term:`Sphinx` as HTML and LaTeX.
+         * Translate LaTeX documentation to PDF using :term:`MikTeX`.

         .. rubric:: Publishing Results

         * GitHub Pipeline Summary

-           * Publish unittest results using :gh:`dorny/test-reporter`.
+           * Publish unittest results using :term:`Test Reporter`.

-         * GitHub Pages
+         * :term:`GitHub Pages`

           * Publish HTML documentation to GitHub Pages.

-         * Codacy
-
-           * Publish code coverage to Codacy.
-
-         * CodeCov
+         * :term:`Codecov`

           * Publish code coverage to CodeCov.
           * Publish unittest results to CodeCov.

+         * :term:`Codacy`
+
+           * Publish code coverage to Codacy.
+
      .. grid-item::
         :columns: 4

         .. rubric:: Packaging

-         * Package as wheel.
-         * Install wheel on target platform.
-         * Upload to PyPI.
+         * Package as wheel using :term:`build`.
+         * Install wheel on target platform using pip.
+         * Upload to PyPI using :term:`twine`.

         .. rubric:: Releasing

--- a/doc/JobTemplate/AllInOne/index.rst
+++ b/doc/JobTemplate/AllInOne/index.rst
@@ -14,7 +14,7 @@ Such a all-in-one workflow template covers:
 * pulishing of unit test and code coverage results
 * merging of test reports
 * packaging as wheel
-* publishing wheels tp PyPI
+* publishing wheels to PyPI
 * documentation generation via Sphinx and Miktex
 * automatic tagging of release commits
 * releasing
--- a/doc/JobTemplate/Cleanup/ArtifactCleanup.rst
+++ b/doc/JobTemplate/Cleanup/ArtifactCleanup.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/ArtifactCleanup:
+.. index::
+   single: delete-artifact; ArtifactCleanUp Template
+   single: GitHub Action Reusable Workflow; ArtifactCleanUp Template

 ArtifactCleanUp
 ###############
--- a/doc/JobTemplate/Cleanup/IntermediateCleanup.rst
+++ b/doc/JobTemplate/Cleanup/IntermediateCleanup.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/IntermediateCleanUp:
+.. index::
+   single: delete-artifact; IntermediateCleanUp Template
+   single: GitHub Action Reusable Workflow; IntermediateCleanUp Template

 IntermediateCleanUp
 ###################
--- a/doc/JobTemplate/Documentation/LaTeXDocumentation.rst
+++ b/doc/JobTemplate/Documentation/LaTeXDocumentation.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/LaTeXDocumentation:
+.. index::
+   single: MikTeX; LaTeXDocumentation Template
+   single: GitHub Action Reusable Workflow; LaTeXDocumentation Template

 LaTeXDocumentation
 ##################
--- a/doc/JobTemplate/Documentation/PublishToGitHubPages.rst
+++ b/doc/JobTemplate/Documentation/PublishToGitHubPages.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/PublishToGitHubPages:
+.. index::
+   single: GitHub Pages; PublishToGitHubPages Template
+   single: GitHub Action Reusable Workflow; PublishToGitHubPages Template

 PublishToGitHubPages
 ####################
--- a/doc/JobTemplate/Documentation/SphinxDocumentation.rst
+++ b/doc/JobTemplate/Documentation/SphinxDocumentation.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/SphinxDocumentation:
+.. index::
+   single: Sphinx; SphinxDocumentation Template
+   single: GitHub Action Reusable Workflow; SphinxDocumentation Template

 SphinxDocumentation
 ###################
--- a/doc/JobTemplate/Package/InstallPackage.rst
+++ b/doc/JobTemplate/Package/InstallPackage.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/InstallPackage:
+.. index::
+   single: pip; InstallPackage Template
+   single: GitHub Action Reusable Workflow; InstallPackage Template

 InstallPackage (beta)
 #####################
--- a/doc/JobTemplate/Package/Package.rst
+++ b/doc/JobTemplate/Package/Package.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/Package:
+.. index::
+   single: build; Package Template
+   single: GitHub Action Reusable Workflow; Package Template

 Package
 #######
--- a/doc/JobTemplate/Package/PublishOnPyPI.rst
+++ b/doc/JobTemplate/Package/PublishOnPyPI.rst
@@ -1,4 +1,8 @@
 .. _JOBTMPL/PublishOnPyPI:
+.. index::
+   single: PyPI; PublishOnPyPI Template
+   single: twine; PublishOnPyPI Template
+   single: GitHub Action Reusable Workflow; PublishOnPyPI Template

 PublishOnPyPI
 #############
--- a/doc/JobTemplate/Publish/PublishCoverageResults.rst
+++ b/doc/JobTemplate/Publish/PublishCoverageResults.rst
@@ -1,4 +1,9 @@
 .. _JOBTMPL/PublishCoverageResults:
+.. index::
+   single: CodeCov; PublishCoverageResults Template
+   single: Codacy; PublishCoverageResults Template
+   single: Coverage.py; PublishCoverageResults Template
+   single: GitHub Action Reusable Workflow; PublishCoverageResults Template

 PublishCoverageResults
 ######################
--- a/doc/JobTemplate/Publish/PublishTestResults.rst
+++ b/doc/JobTemplate/Publish/PublishTestResults.rst
@@ -1,4 +1,9 @@
 .. _JOBTMPL/PublishTestResults:
+.. index::
+   single: CodeCov; PublishTestResults Template
+   single: pyEDAA.Reports; PublishTestResults Template
+   single: Test Reporter; PublishTestResults Template
+   single: GitHub Action Reusable Workflow; PublishTestResults Template

 PublishTestResults
 ##################
--- a/doc/JobTemplate/Quality/CheckDocumentation.rst
+++ b/doc/JobTemplate/Quality/CheckDocumentation.rst
@@ -1,4 +1,8 @@
 .. _JOBTMPL/CheckDocumentation:
+.. index::
+   single: docstr_coverage; CheckDocumentation Template
+   single: interrogate; CheckDocumentation Template
+   single: GitHub Action Reusable Workflow; CheckDocumentation Template

 CheckDocumentation
 ##################
--- a/doc/JobTemplate/Quality/StaticTypeCheck.rst
+++ b/doc/JobTemplate/Quality/StaticTypeCheck.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/StaticTypeCheck:
+.. index::
+   single: mypy; StaticTypeCheck Template
+   single: GitHub Action Reusable Workflow; StaticTypeCheck Template

 StaticTypeCheck
 ###############
--- a/doc/JobTemplate/Release/PublishReleaseNotes.rst
+++ b/doc/JobTemplate/Release/PublishReleaseNotes.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/PublishReleaseNotes:
+.. index::
+   single: gh; PublishReleaseNotes Template
+   single: GitHub Action Reusable Workflow; PublishReleaseNotes Template

 PublishReleaseNotes
 ###################
--- a/doc/JobTemplate/Release/TagReleaseCommit.rst
+++ b/doc/JobTemplate/Release/TagReleaseCommit.rst
@@ -1,4 +1,7 @@
 .. _JOBTMPL/TagReleaseCommit:
+.. index::
+   single: gh; TagReleaseCommit Template
+   single: GitHub Action Reusable Workflow; TagReleaseCommit Template

 TagReleaseCommit
 ################
--- a/doc/JobTemplate/Setup/ExtractConfiguration.rst
+++ b/doc/JobTemplate/Setup/ExtractConfiguration.rst
@@ -1,4 +1,6 @@
 .. _JOBTMPL/ExtractConfiguration:
+.. index::
+   single: GitHub Action Reusable Workflow; ExtractConfiguration Template

 ExtractConfiguration
 ####################
--- a/doc/JobTemplate/Setup/Parameters.rst
+++ b/doc/JobTemplate/Setup/Parameters.rst
@@ -1,4 +1,6 @@
 .. _JOBTMPL/Parameters:
+.. index::
+   single: GitHub Action Reusable Workflow; Parameters Template

 Parameters
 ##########
--- a/doc/JobTemplate/Setup/PrepareJob.rst
+++ b/doc/JobTemplate/Setup/PrepareJob.rst
@@ -1,4 +1,6 @@
 .. _JOBTMPL/PrepareJob:
+.. index::
+   single: GitHub Action Reusable Workflow; PrepareJob Template

 PrepareJob
 ##########
--- a/doc/JobTemplate/Testing/UnitTesting.rst
+++ b/doc/JobTemplate/Testing/UnitTesting.rst
@@ -1,4 +1,8 @@
 .. _JOBTMPL/UnitTesting:
+.. index::
+   single: pytest; UnitTesting Template
+   single: Coverage.py; UnitTesting Template
+   single: GitHub Action Reusable Workflow; UnitTesting Template

 UnitTesting
 ###########
--- a/doc/JobTemplate/index.rst
+++ b/doc/JobTemplate/index.rst
@@ -1,4 +1,6 @@
 .. _JOBTMPL:
+.. index::
+   single: GitHub Action Reusable Workflow

 Overview
 ########
@@ -11,6 +13,8 @@ customizable.


 .. _JOBTMPL/Instantiation:
+.. index::
+   single: GitHub Action Reusable Workflow; Instantiation

 Instantiation
 *************
@@ -56,6 +60,8 @@ Some templates might provide output parameters, which can be used in dependent j


 .. _JOBTMPL/CommonParameters:
+.. index::
+   single: GitHub Action Reusable Workflow; Common Parameters

 Common Parameters
 *****************