Clean links in doc files

Author: jorgepiloto

doc/source/coding_style/flake8.rst

@@ -2,12 +2,10 @@
 
 Style Guide Enforcement
 =======================
-This topic describes the use of `Flake8`_ for `PEP8`_ style
+This topic describes the use of `flake8`_ for `PEP 8`_ style
 enforcement and the minimum standards expected. PyAnsys libraries
 are expected to be consistent with these guidelines.
 
-.. _PEP8: https://www.python.org/dev/peps/pep-0008/
-
 Flake8
 ~~~~~~
 `Flake8`_ is a Python tool for enforcing code styling. It is a wrapper
@@ -16,12 +14,6 @@ around the following three tools: `PyFlakes`_, `pycodestyle`_, and
 checking the code against a variety of style rules, such as line length,
 code complexity, and whitespace.
 
-.. _Flake8: https://flake8.pycqa.org/en/latest/index.html
-.. _PyFlakes: https://pypi.org/project/pyflakes/
-.. _pycodestyle: https://pypi.org/project/pycodestyle/
-.. _`Ned Batchelder's McCabe script for complexity`: https://github.com/PyCQA/mccabe
-.. _configuring-flake8:
-
 Configuring Flake8
 ------------------
 Flake8 supports configuring a specific set of style rules to
@@ -70,7 +62,7 @@ The example configuration defines the following options:
 
 - ``max-line-length``
     Denotes the maximum line length for any one line of code.
-    The `PEP8`_ standard advises a maximum line length of 79. Because
+    The `PEP 8`_ standard advises a maximum line length of 79. Because
     this is a bit limiting in some cases, the maximum line length
     recommended for a PyAnsys library is 100.
 
@@ -106,25 +98,22 @@ base.
 Utilizing Black
 ~~~~~~~~~~~~~~~
 Manually checking for code styling can be a tedious task. Luckily,
-several Python tools for auto-formatting code to meet PEP8 standards
+several Python tools for auto-formatting code to meet `PEP 8`_ standards
 are available to help with this. The PyAnsys project suggests the use of the
 the formatting tool `black`_.
 
 On completing a code change, and before committing, `black`_ can be
-run to reformat the code, following the PEP8 guidelines enforced through
-Flake8. This will limit any manual code changes needed to address style
+run to reformat the code, following the `PEP 8`_ guidelines enforced through
+`flake8`_. This will limit any manual code changes needed to address style
 rules.
 
-.. _black: https://black.readthedocs.io/en/stable/
 
 Optionally, it is possible to automate the use of `black`_. This can be
 done with the tool `pre-commit`_. Setting up a `pre-commit hook
 to run black <https://black.readthedocs.io/en/stable/integrations/source_version_control.html>`_
 will automatically format the code before committing. This simple way of
 incorporating code style checks into the development workflow to maintain
-PEP8 guidelines requires minimal manual effort.
-
-.. _pre-commit: https://pre-commit.com/
+`PEP 8`_ guidelines requires minimal manual effort.
 
 
 Minimum Standards
@@ -232,21 +221,4 @@ Your ``.flake8`` file should be:
     max-line-length = 100
     statistics = True
 
-
-.. _W191: https://www.flake8rules.com/rules/W191.html
-.. _W291: https://www.flake8rules.com/rules/W291.html
-.. _W293: https://www.flake8rules.com/rules/W293.html
-.. _W391: https://www.flake8rules.com/rules/W391.html
-.. _E115: https://www.flake8rules.com/rules/E115.html
-.. _E117: https://www.flake8rules.com/rules/E117.html
-.. _E122: https://www.flake8rules.com/rules/E122.html
-.. _E124: https://www.flake8rules.com/rules/E124.html
-.. _E125: https://www.flake8rules.com/rules/E125.html
-.. _E225: https://www.flake8rules.com/rules/E225.html
-.. _E231: https://www.flake8rules.com/rules/E231.html
-.. _E301: https://www.flake8rules.com/rules/E301.html
-.. _E303: https://www.flake8rules.com/rules/E303.html
-.. _E501: https://www.flake8rules.com/rules/E501.html
-.. _F401: https://www.flake8rules.com/rules/F401.html
-.. _F403: https://www.flake8rules.com/rules/F403.html
-
+.. include:: ../links.rst

doc/source/coding_style/index.rst

@@ -1,17 +1,10 @@
-.. _coding_style:
-
 Coding Style
 ************
 
-PyAnsys libraries are expected to follow `PEP8`_ and
+PyAnsys libraries are expected to follow `PEP 8`_ and
 be consistent in style and formatting with the 'big three'
 data science libraries: `NumPy`_, `SciPy`_, and `pandas`_.
 
-.. _NumPy: https://numpy.org/
-.. _SciPy: https://www.scipy.org/
-.. _pandas: https://pandas.pydata.org/
-.. _PEP8: https://www.python.org/dev/peps/pep-0008/
-
 
 .. todo::
 
@@ -27,3 +20,5 @@ data science libraries: `NumPy`_, `SciPy`_, and `pandas`_.
    pep8_best_practices
    beyond_pep8
    flake8
+
+.. include:: ../links.rst

doc/source/coding_style/pep8_best_practices.rst

@@ -7,11 +7,6 @@ they apply to PyAnsys libraries. The goal is for PyAnsys libraries to
 be consistent in style and formatting with the `big three`
 data science libraries: `NumPy`_, `SciPy`_, and `pandas`_.
 
-.. _NumPy: https://numpy.org/
-.. _SciPy: https://www.scipy.org/
-.. _pandas: https://pandas.pydata.org/
-.. _PEP8: https://www.python.org/dev/peps/pep-0008/
-
 
 Imports
 ~~~~~~~

doc/source/documentation_style/formatting-tools.rst

@@ -88,13 +88,4 @@ under the ``[tool.pydocstyle]`` entry:
    [tool.pydocstyle]
    # Additional configuration
 
-
-.. _interrogate: https://interrogate.readthedocs.io/en/latest/
-.. _docstr-coverage: https://docstr-coverage.readthedocs.io/en/latest/index.html
-.. _docstring-coverage: https://bitbucket.org/DataGreed/docstring-coverage/wiki/Home
-.. _pytest-cov: https://pytest-cov.readthedocs.io/en/latest/
-.. _doctest: https://docs.python.org/3/library/doctest.html
-.. _PEP 257: http://www.python.org/dev/peps/pep-0257/
-.. _docformatter: https://github.com/PyCQA/docformatter
-.. _codespell: https://github.com/codespell-project/codespell
-.. _pytest-cov: https://pytest-cov.readthedocs.io/en/latest/
+.. include:: ../links.rst

doc/source/index.rst

@@ -13,3 +13,5 @@
    coding_style/index
    documentation_style/index
    abstractions/index
+
+.. include:: links.rst

doc/source/packaging/structure.rst

@@ -282,7 +282,6 @@ template can be used:
 .. REFERENCES & LINKS
 
 .. _MIT License: https://opensource.org/licenses/MIT
-.. _PEP 420: https://peps.python.org/pep-0420/
 .. _native namespace packages: https://packaging.python.org/en/latest/guides/packaging-namespace-packages/#native-namespace-packages
 .. _Namespace Packages: https://packaging.python.org/guides/packaging-namespace-packages/
 .. _PyAnsys: https://docs.pyansys.com/
@@ -295,7 +294,8 @@ template can be used:
 .. _ansys-api-mapdl: https://pypi.org/project/ansys-api-mapdl/
 .. _reStructuredText Markup Syntax: https://docutils.sourceforge.io/rst.html
 .. _Markdown Syntax: https://www.markdownguide.org/basic-syntax/
-.. _PEP 518: https://peps.python.org/pep-0518/
 .. _Building and Distributing Packages with Setuptools: https://setuptools.pypa.io/en/latest/setuptools.html
 .. _Configuring setuptools using setup.cfg files: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html
 .. _setuptools: https://setuptools.pypa.io/en/latest/index.html
+
+.. include:: ../links.rst