Skip to content

Commit a8e4c60

Browse files
committed
Improved links.
1 parent c054718 commit a8e4c60

6 files changed

Lines changed: 21 additions & 20 deletions

File tree

doc/JobTemplate/AllInOne/CompletePipeline.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ PYPI_TOKEN
781781
:Type: string
782782
:Required: no
783783
:Default Value: — — — —
784-
:Description: The token to publish and upload packages on `PyPI <https://pypi.org/>`__.
784+
:Description: The token to publish and upload packages on :term:`PyPI`.
785785

786786

787787
.. _JOBTMPL/CompletePipeline/Secret/CODECOV_TOKEN:
@@ -792,7 +792,7 @@ CODECOV_TOKEN
792792
:Type: string
793793
:Required: no
794794
:Default Value: — — — —
795-
:Description: The token to publish code coverage and unit test results to `CodeCov <https://about.codecov.io//>`__.
795+
:Description: The token to publish code coverage and unit test results to :term:`CodeCov`.
796796

797797

798798
.. _JOBTMPL/CompletePipeline/Secret/CODACY_TOKEN:
@@ -803,7 +803,7 @@ CODACY_TOKEN
803803
:Type: string
804804
:Required: no
805805
:Default Value: — — — —
806-
:Description: The token to publish code coverage results to `Codacy <https://www.codacy.com/>`__.
806+
:Description: The token to publish code coverage results to :term:`Codacy`.
807807

808808

809809
.. _JOBTMPL/CompletePipeline/Outputs:

doc/JobTemplate/Package/InstallPackage.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ the installation is verified. This aims for packaging and dependency mistakes in
1212
.. topic:: Features
1313

1414
* Install generated Python package on the target platform.
15+
* Verify the installed package's version.
1516

1617
.. topic:: Behavior
1718

1819
* Download Python package as artifact.
1920
* Prepare the Python environment.
20-
* Install the Python package using ``pip``.
21+
* Install the Python package using :term:`pip`.
2122
* Read out and verify the package version.
2223

2324
.. topic:: Job Execution

doc/JobTemplate/Package/PublishOnPyPI.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
PublishOnPyPI
88
#############
99

10-
Publish a wheel (``*.whl``) packages and/or source (``*.tar.gz``) package to `PyPI <https://pypi.org/>`__.
10+
Publish a wheel (``*.whl``) packages and/or source (``*.tar.gz``) package to :term:`PyPI`.
1111

1212
.. topic:: Features
1313

14-
* Publish a Python package to `PyPI <https://pypi.org/>`__.
14+
* Publish a Python package to :term:`PyPI`.
1515

1616
.. topic:: Behavior
1717

@@ -191,7 +191,7 @@ PYPI_TOKEN
191191
:Type: string
192192
:Required: no
193193
:Default Value: — — — —
194-
:Description: The token to publish and upload packages on `PyPI <https://pypi.org/>`__.
194+
:Description: The token to publish and upload packages on :term:`PyPI`.
195195

196196

197197
.. _JOBTMPL/PublishOnPyPI/Outputs:

doc/JobTemplate/Publish/PublishCoverageResults.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,7 +424,7 @@ CODECOV_TOKEN
424424
:Type: string
425425
:Required: no
426426
:Default Value: — — — —
427-
:Description: The token to publish code coverage and unit test results to `CodeCov <https://about.codecov.io//>`__.
427+
:Description: The token to publish code coverage and unit test results to :term:`CodeCov`.
428428

429429

430430
.. _JOBTMPL/PublishCoverageResults/Secret/CODACY_TOKEN:
@@ -435,7 +435,7 @@ CODACY_TOKEN
435435
:Type: string
436436
:Required: no
437437
:Default Value: — — — —
438-
:Description: The token to publish code coverage results to `Codacy <https://www.codacy.com/>`__.
438+
:Description: The token to publish code coverage results to :term:`Codacy`.
439439

440440

441441

doc/JobTemplate/Publish/PublishTestResults.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ JUnit test summary reports to multiple services for visualization and longterm s
1313

1414
Supported services are:
1515

16-
* GitHub Actions job results using :gh:`dorny/test-reporter`
17-
* `Codecov <https://about.codecov.io/>`__
16+
* GitHub Actions job results using :term:`Test Reporter`
17+
* :term:`Codecov`
1818

1919
.. topic:: Features
2020

@@ -29,10 +29,10 @@ Supported services are:
2929
pattern (see :ref:`JOBTMPL/PublishTestResults/Input/unittest_artifacts_pattern`) for limiting the number of
3030
downloaded artifacts and the hereby generated traffic.
3131
3. Rename the found JUnit XML files.
32-
4. Merge all found JUnit XML files using :pypi:`pyEDAA.Reports` into a new JUnit XML file. |br|
32+
4. Merge all found JUnit XML files using :term:`pyEDAA.Reports` into a new JUnit XML file. |br|
3333
Optionally, apply certain transformation and cleanup operations to the JUnit report structure.
34-
5. Publish test results as a markdown report page to GitHub Actions using :gh:`dorny/test-reporter`.
35-
6. Publish test results to `Codecov <https://about.codecov.io/>`__ using :gh:`codecov/test-results-action`.
34+
5. Publish test results as a markdown report page to GitHub Actions using :term:`Test Reporter`.
35+
6. Publish test results to :term:`Codecov` using :gh:`codecov/test-results-action`.
3636

3737
.. topic:: Job Execution
3838

@@ -325,7 +325,7 @@ CODECOV_TOKEN
325325
:Type: string
326326
:Required: no
327327
:Default Value: — — — —
328-
:Description: The token to publish unit test results on `Codecov <https://about.codecov.io/>`__.
328+
:Description: The token to publish unit test results on :term:`CodeCov`.
329329

330330

331331
.. _JOBTMPL/PublishTestResults/Outputs:

doc/JobTemplate/Testing/UnitTesting.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ UnitTesting
1010
This template runs multiple jobs from a matrix as a cross of Python versions and systems. The summary report in junit
1111
XML format is optionally uploaded as an artifact.
1212

13-
Configuration options to ``pytest`` should be given via section ``[tool.pytest.ini_options]`` in a ``pyproject.toml``
14-
file.
13+
Configuration options to :term:`pytest` should be given via section ``[tool.pytest.ini_options]`` in a
14+
``pyproject.toml`` file.
1515

1616
.. topic:: Features
1717

18-
* Execute unit tests using `pytest <https://docs.pytest.org/en/stable/>`__.
18+
* Execute unit tests using :term:`pytest`.
1919

2020
* Provide unit test results as JUnit XML file (pyTest XML dialect).
2121

22-
* Collect code coverage using `Coverage.py <https://coverage.readthedocs.io/>`__.
22+
* Collect code coverage using :term:`Coverage.py`.
2323

2424
* Provide code coverage results as pytest SQLite database.
2525
* Provide code coverage results as Cobertura XML file.
@@ -30,7 +30,7 @@ file.
3030

3131
1. Checkout repository.
3232
2. Setup environment and install dependencies (``apt``, ``homebrew``, ``pacman``, ...).
33-
3. Setup Python and install dependencies (``pip``).
33+
3. Setup Python and install dependencies (:term:`pip`).
3434
4. Run instructions from ``*_before_script`` parameter.
3535
5. Run unit tests using *pytest* and if enabled in combination with *Coverage.py*.
3636
6. Convert gathered results to other formats.

0 commit comments

Comments
 (0)