Merge branch 'feature/redo-docs-refactor' into develop

Author: 56kyle

docs/conf.py

@@ -16,6 +16,7 @@
 extensions = [
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
+    "sphinx.ext.extlinks",
     "myst_parser",
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
@@ -45,6 +46,7 @@
     "dollarmath",
     "html_admonition",
     "html_image",
+    "linkify",
     "replacements",
     "smartquotes",
     "strikethrough",
@@ -54,6 +56,71 @@
     "attrs_block",
 ]
 
+extlinks = {
+    "argocd": ("https://argo-cd.readthedocs.io/%s", None),
+    "autopep8": ("https://pypi.org/project/autopep8/%s", None),
+    "bandit-bandit": ("https://bandit.readthedocs.io/%s", None),
+    "bandit": ("https://github.com/PyCQA/bandit/%s", None),
+    "beartype": ("https://beartype.readthedocs.io/%s", None),
+    "bitbucket-pipelines": ("https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/%s", None),
+    "black": ("https://black.readthedocs.io/%s", None),
+    "build": ("https://pypa-build.readthedocs.io/%s", None),
+    "cobertura": ("https://cobertura.github.io/cobertura/xml.html%s", None),
+    "commitizen": ("https://commitizen-tools.github.io/commitizen/%s", None),
+    "conventional-commits": ("https://www.conventionalcommits.org/en/v1.0.0/%s", None),
+    "coverage-py": ("https://coverage.readthedocs.io/%s", None),
+    "cruft": ("https://cruft.github.io/cruft/%s", None),
+    "docker-compose": ("https://docs.docker.com/compose/%s", None),
+    "docker": ("https://docs.docker.com/%s", None),
+    "docker-install": ("https://docs.docker.com/engine/install/%s", None),
+    "flake8": ("https://flake8.pycqa.org/%s", None),
+    "flit": ("https://flit.pypa.io/%s", None),
+    "github-actions": ("https://docs.github.com/en/actions/%s", None),
+    "gitlab-ci": ("https://docs.gitlab.com/ee/ci/%s", None),
+    "hatch": ("https://hatch.pypa.io/%s", None),
+    "hatchling": ("https://hatch.pypa.io/latest/hatchling/%s", None),
+    "helm": ("https://helm.sh/%s", None),
+    "invoke": ("https://www.pyinvoke.org/%s", None),
+    "isort": ("https://pycqa.github.io/isort/%s", None),
+    "junit": ("https://llg.cubic.org/docs/junit/%s", None),
+    "just": ("https://just.systems/%s", None),
+    "maturin": ("https://maturin.rs/%s", None),
+    "mkdocs": ("https://www.mkdocs.org/%s", None),
+    "mypy": ("https://mypy-lang.org/%s", None),
+    "myst-parser": ("https://myst-parser.readthedocs.io/%s", None),
+    "nox": ("https://nox.thea.codes/%s", None),
+    "pdm": ("https://pdm.fming.dev/%s", None),
+    "pip-audit": ("https://github.com/pypa/pip-audit/%s", None),
+    "pip": ("https://pip.pypa.io/%s", None),
+    "pip-tools": ("https://pip-tools.readthedocs.io/%s", None),
+    "podman": ("https://podman.io/%s", None),
+    "podman-install": ("https://podman.io/docs/installation/%s", None),
+    "poethepoet": ("https://github.com/nat-n/poethepoet/%s", None),
+    "poetry": ("https://python-poetry.org/%s", None),
+    "pre-commit": ("https://pre-commit.com/%s", None),
+    "pydocstyle": ("https://www.pydocstyle.org/%s", None),
+    "pylint": ("https://pylint.pycqa.org/%s", None),
+    "pypi-trusted-publishers": ("https://docs.pypi.org/trusted-publishers/%s", None),
+    "pyright": ("https://github.com/microsoft/pyright/%s", None),
+    "pytest": ("https://docs.pytest.org/%s", None),
+    "pytest-pytest-cov": ("https://pytest-cov.readthedocs.io/%s", None),
+    "pytype": ("https://github.com/google/pytype/%s", None),
+    "ruff": ("https://docs.astral.sh/ruff/%s", None),
+    "safety": ("https://pyup.io/%s", None),
+    "setuptools": ("https://setuptools.pypa.io/%s", None),
+    "sonarcloud": ("https://sonarcloud.io/%s", None),
+    "sphinx": ("https://www.sphinx-doc.org/%s", None),
+    "sphinxautodoctypehints": ("https://sphinx-autodoc-typehints.readthedocs.io/%s", None),
+    "tox": ("https://tox.readthedocs.io/%s", None),
+    "twine": ("https://twine.readthedocs.io/%s", None),
+    "unittest": ("https://docs.python.org/3/library/unittest.html%s", None),
+    "uv": ("https://docs.uv.dev/%s", None),
+    "uv-install": ("https://docs.astral.sh/uv/installation/%s", None),
+    "venv": ("https://docs.python.org/3/library/venv%s", None),
+    "virtualenv": ("https://virtualenv.pypa.io/%s", None),
+    "yapf": ("https://github.com/google/yapf/%s", None)
+}
+
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "pip": ("https://pip.pypa.io/en/stable/", None),

docs/getting-started-template-contributing.md

@@ -8,7 +8,7 @@ To contribute to the template, you will need:
 
 1.  **Git**: For version control.
 2.  **Python 3.9+**: We recommend using a supported Python version.
-3.  **uv**: Our chosen dependency manager (see [Dependency Management (02)](topics/02_dependency-management.md)). Install `uv` globally or in a base environment following the official [uv installation guide](https://docs.astral.sh/uv/installation/).
+3.  **uv**: Our chosen dependency manager (see [Dependency Management (02)](topics/02_dependency-management.md)). Install `uv` globally or in a base environment following the official {uv-install}`uv installation guide<>`.
 4.  **Docker or Podman**: Required for testing the containerization aspects of the generated template (see [Container Build (11)](topics/11_container-build.md), [Dev Containers (17)](topics/17_dev-containers.md)).
 5.  **Task Automation Tools**: The template itself uses a `noxfile.py` to manage its own development and documentation build workflows. Install `nox`:
     ```bash