Skip to content

Commit e0c396b

Browse files
committed
docs: replace all hard coded links with extlinks
1 parent eed89c6 commit e0c396b

File tree

5 files changed

+14
-7
lines changed

5 files changed

+14
-7
lines changed

docs/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,14 @@
6565
"bitbucket-pipelines": ("https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/%s", None),
6666
"black": ("https://black.readthedocs.io/%s", None),
6767
"build": ("https://pypa-build.readthedocs.io/%s", None),
68+
"cobertura": ("https://cobertura.github.io/cobertura/xml.html%s", None),
6869
"commitizen": ("https://commitizen-tools.github.io/commitizen/%s", None),
70+
"conventional-commits": ("https://www.conventionalcommits.org/en/v1.0.0/%s", None),
6971
"coverage.py": ("https://coverage.readthedocs.io/%s", None),
7072
"cruft": ("https://cruft.github.io/cruft/%s", None),
7173
"docker-compose": ("https://docs.docker.com/compose/%s", None),
7274
"docker": ("https://docs.docker.com/%s", None),
75+
"docker-install": ("https://docs.docker.com/engine/install/%s", None),
7376
"flake8": ("https://flake8.pycqa.org/%s", None),
7477
"flit": ("https://flit.pypa.io/%s", None),
7578
"github-actions": ("https://docs.github.com/en/actions/%s", None),
@@ -79,6 +82,7 @@
7982
"helm": ("https://helm.sh/%s", None),
8083
"invoke": ("https://www.pyinvoke.org/%s", None),
8184
"isort": ("https://pycqa.github.io/isort/%s", None),
85+
"junit": ("https://llg.cubic.org/docs/junit/%s", None),
8286
"just": ("https://just.systems/%s", None),
8387
"maturin": ("https://maturin.rs/%s", None),
8488
"mkdocs": ("https://www.mkdocs.org/%s", None),
@@ -90,11 +94,13 @@
9094
"pip": ("https://pip.pypa.io/%s", None),
9195
"pip-tools": ("https://pip-tools.readthedocs.io/%s", None),
9296
"podman": ("https://podman.io/%s", None),
97+
"podman-install": ("https://podman.io/docs/installation/%s", None),
9398
"poethepoet": ("https://github.com/nat-n/poethepoet/%s", None),
9499
"poetry": ("https://python-poetry.org/%s", None),
95100
"pre-commit": ("https://pre-commit.com/%s", None),
96101
"pydocstyle": ("https://www.pydocstyle.org/%s", None),
97102
"pylint": ("https://pylint.pycqa.org/%s", None),
103+
"pypi-trusted-publishers": ("https://docs.pypi.org/trusted-publishers/%s", None),
98104
"pyright": ("https://github.com/microsoft/pyright/%s", None),
99105
"pytest": ("https://docs.pytest.org/%s", None),
100106
"pytest-pytest-cov": ("https://pytest-cov.readthedocs.io/%s", None),
@@ -108,6 +114,7 @@
108114
"tox": ("https://tox.readthedocs.io/%s", None),
109115
"twine": ("https://twine.readthedocs.io/%s", None),
110116
"uv": ("https://docs.uv.dev/%s", None),
117+
"uv-install": ("https://docs.astral.sh/uv/installation/%s", None),
111118
"venv": ("https://docs.python.org/3/library/venv%s", None),
112119
"virtualenv": ("https://virtualenv.pypa.io/%s", None),
113120
"yapf": ("https://github.com/google/yapf/%s", None)

docs/getting-started-template-contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To contribute to the template, you will need:
88

99
1. **Git**: For version control.
1010
2. **Python 3.9+**: We recommend using a supported Python version.
11-
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/).
11+
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](uv-install-documentation).
1212
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)).
1313
5. **Task Automation Tools**: The template itself uses a `noxfile.py` to manage its own development and documentation build workflows. Install `nox`:
1414
```bash

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Make sure you have these installed:
1212

1313
- **Python 3.9+** (or your chosen template version).
1414
- **Git**.
15-
- **uv**: Our chosen dependency manager. Install it [officially](https://docs.astral.sh/uv/installation/).
16-
- **Docker or Podman**: If you plan to work with containers (most web apps will need this). Install [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation/).
15+
- **uv**: Our chosen dependency manager. Install it [officially](uv-install-documentation).
16+
- **Docker or Podman**: If you plan to work with containers (most web apps will need this). Install [Docker](docker-install-documentation) or [Podman](podman-install-documentation).
1717

1818
## 2. Create Your Project
1919

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Your project uses [:term:`uv`](uv-documentation) to manage dependencies, environ
4848
# Manual activation: source .venv/bin/activate (Linux/macOS), .venv\Scripts\activate.bat (Windows cmd)
4949
```
5050

51-
Refer to the [uv documentation](https://docs.astral.sh/uv/cli/) for more advanced usage.
51+
Refer to the [uv documentation](uv-documentation) for more advanced usage.
5252

5353
## Code Quality Checks
5454

@@ -130,7 +130,7 @@ Use [:term:`Commitizen`](commitizen-documentation) ([Topic 12](topics/12_task-au
130130
```bash
131131
uvx nox -s release -- [major|minor|patch] # e.g., uvx nox -s release -- minor
132132
```
133-
Follow the prompts. Requires following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Pushing the resulting tag often triggers the CD pipeline.
133+
Follow the prompts. Requires following [Conventional Commits](conventional-commits-documentation). Pushing the resulting tag often triggers the CD pipeline.
134134

135135
## Advanced Usage & Customization
136136

docs/workflow/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ The workflow extends seamlessly to automation platforms using the Task Automatio
6464
- Sets up the necessary Python version(s) and environment.
6565
- Installs [:term:`uv`](uv-documentation) and [:term:`Nox`](nox-documentation).
6666
- Runs key Task Automation commands: `uvx nox -s check`, `uvx nox -s test`.
67-
- Collects reports ([JUnit XML](https://llg.cubic.org/docs/junit/), [Cobertura XML](https://cobertura.github.io/cobertura/xml.html)).
67+
- Collects reports ([JUnit XML](junit-documentation), [Cobertura XML](cobertura-documentation)).
6868
- Reports status back to the version control platform.
6969
This process runs tests and checks reliably across the matrix of Python versions defined in the `noxfile.py` and potentially operating systems supported by the CI platform.
7070
7171
2. **Continuous Deployment / Delivery (CD):** Triggered by events like successful CI runs on the main branch or Git tags. The CD configuration ([CD Orchestration (14)](../topics/14_cd_orchestration.md)) is also a thin orchestration layer:
7272
- Sets up the environment.
73-
- Manages secure credentials ([API tokens](https://docs.pypi.org/trusted-publishers/) for PyPI, registry secrets).
73+
- Manages secure credentials ([API tokens](pypi-trusted-publishers-documentation) for PyPI, registry secrets).
7474
- Runs Task Automation commands to build artifacts: `uvx nox -s build:package` ([Packaging Build (09)](../topics/09_packaging-build.md)), `uvx nox -s build:container` ([Container Build (11)](../topics/11_container-build.md)).
7575
- Runs Task Automation commands to publish artifacts: `uvx nox -s publish` ([Packaging Publishing (10)](../topics/10_packaging-publish.md)), or uses Docker CLI to push container images.
7676

0 commit comments

Comments
 (0)