Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
105 commits
Select commit Hold shift + click to select a range
ed7070a
chore: add name to remove_demo_release nox session
56kyle Jul 19, 2025
46af11c
fix: adjust session decorator kwargs throughout template noxfile
56kyle Jul 19, 2025
89307d2
docs: swap from glossary to using sphinx extlinks
56kyle Jul 19, 2025
3fbc5f1
docs: replace non existent pip intersphinx usage with extlink
56kyle Jul 19, 2025
c21b6e5
Revert "docs: replace non existent pip intersphinx usage with extlink"
56kyle Jul 19, 2025
5a34137
Revert "docs: swap from glossary to using sphinx extlinks"
56kyle Jul 19, 2025
b5b037b
docs: begin to replace glossary with sphinx extlinks
56kyle Jul 19, 2025
81153f9
docs: mass refactor of glossary links to use extlinks instead
56kyle Jul 19, 2025
168ee1a
docs: remove glossary from toctree
56kyle Jul 19, 2025
d75565b
docs: replace faulty links for uv
56kyle Jul 19, 2025
4b8bf14
docs: fix broken pip links
56kyle Jul 19, 2025
4bbfa55
docs: refactor more glossary links to sphinx extlinks
56kyle Jul 19, 2025
905632c
docs: add linkify to the list of myst extensions
56kyle Jul 19, 2025
9fe6168
build: add linkify to the myst-parser dependency
56kyle Jul 19, 2025
84579fc
docs: add the role extension to myst_parser
56kyle Jul 19, 2025
44314b6
docs: mass syntax refactor to hopefully solve extlink usage error
56kyle Jul 19, 2025
a9bfa7a
docs: remove faulty extension
56kyle Jul 19, 2025
5f55d20
docs: add missing extension for extlinks
56kyle Jul 19, 2025
e6cac5b
docs: replace old extlinks usage with newer None version
56kyle Jul 19, 2025
48f4b13
docs: fix more extlinks
56kyle Jul 20, 2025
402ec25
docs: mass refactor to swap role with representation where incorrectl…
56kyle Jul 20, 2025
94fecbd
docs: adjust syntax used for extlinks to include a blank <> with each…
56kyle Jul 20, 2025
6e82979
docs: remove old role prefix from some broken sphinx extlinks
56kyle Jul 20, 2025
20545ac
docs: add venv to the extlinks and fix some more usage errors
56kyle Jul 20, 2025
e0808ad
docs: replace venv-tutorial with venv
56kyle Jul 20, 2025
5ec9395
docs: replace coveragepy-documentation with coverage.py
56kyle Jul 20, 2025
d4ab8d5
docs: replace coveragepy-coverage-documentation with coverage.py
56kyle Jul 20, 2025
96a84bd
docs: update the coverage extlink
56kyle Jul 20, 2025
6b10a3f
docs: fix issues related to lost info in 04_code-linting.md
56kyle Jul 20, 2025
aabab9a
docs: manually fix some messed up refactors
56kyle Jul 20, 2025
a622f49
build: add linkify to the myst-parser dependency
56kyle Jul 21, 2025
a5c5f12
docs: swap from myst glossary to sphinx extlinks
56kyle Jul 21, 2025
9452988
docs: replace edge case urls in 02_dependency-management.md
56kyle Jul 21, 2025
2edc533
docs: replace url edge cases in testing coverage docs
56kyle Jul 21, 2025
e437760
docs: replace url edge cases in type checking documentation
56kyle Jul 21, 2025
8c3c002
docs: fix several url edge cases in 04_code-linting.md
56kyle Jul 21, 2025
eed89c6
docs: add several incorrect url fixes
56kyle Jul 21, 2025
e0c396b
docs: replace all hard coded links with extlinks
56kyle Jul 23, 2025
01c2dc0
docs: remove faulty extlink references in 05_type-checking.md
56kyle Jul 23, 2025
15a3a72
docs: remove faulty extlink references in 12_task-automation.md
56kyle Jul 23, 2025
33a8cdb
docs: replace faulty venv documentation link
56kyle Jul 23, 2025
109ccb4
docs: replace sphinx napoleon links with temp placeholder
56kyle Jul 23, 2025
7251f03
docs: change all glossary syntax urls to use sphinx extlink syntax
56kyle Jul 23, 2025
d98ec3f
docs: remove faulty toctree link
56kyle Jul 24, 2025
165bdd0
docs: remove documentation suffix from all sphinx extlink links
56kyle Jul 24, 2025
7c59e2c
Revert "docs: remove documentation suffix from all sphinx extlink links"
56kyle Jul 24, 2025
d708962
Revert "docs: change all glossary syntax urls to use sphinx extlink s…
56kyle Jul 24, 2025
e69e547
docs: convert all custom text links that plan on using ext links to h…
56kyle Jul 24, 2025
aa86ff2
docs: convert all term urls into extlinks
56kyle Jul 24, 2025
37c3a28
docs: manually fix a few broken relative links
56kyle Jul 24, 2025
162313d
docs: fix ruff link
56kyle Jul 24, 2025
417aad6
Revert "docs: fix ruff link"
56kyle Jul 24, 2025
0282e96
Revert "docs: manually fix a few broken relative links"
56kyle Jul 24, 2025
fd070a3
Revert "docs: convert all term urls into extlinks"
56kyle Jul 24, 2025
0cab816
docs: replace terms with sphinx extlinks minus the documentation suffix
56kyle Jul 24, 2025
fa1390e
Reapply "docs: manually fix a few broken relative links"
56kyle Jul 24, 2025
17139e4
docs: fix ruff link
56kyle Jul 24, 2025
432e13d
Revert "docs: fix ruff link"
56kyle Jul 24, 2025
24ee39c
Revert "Reapply "docs: manually fix a few broken relative links""
56kyle Jul 24, 2025
f72144f
Revert "docs: replace terms with sphinx extlinks minus the documentat…
56kyle Jul 24, 2025
5f6d4bd
docs: replace terms with extlinks minus the -documentation suffix and…
56kyle Jul 24, 2025
d5e0f18
Reapply "Reapply "docs: manually fix a few broken relative links""
56kyle Jul 24, 2025
bdeffe2
docs: fix already broken ruff link
56kyle Jul 24, 2025
2860f4b
Revert "docs: fix already broken ruff link"
56kyle Jul 24, 2025
9c20b3e
Revert "Reapply "Reapply "docs: manually fix a few broken relative li…
56kyle Jul 24, 2025
104a95f
Revert "docs: replace terms with extlinks minus the -documentation su…
56kyle Jul 24, 2025
ff8f5ca
docs: replace terms with sphinx extlinks
56kyle Jul 24, 2025
7b77bd0
Reapply "Reapply "Reapply "docs: manually fix a few broken relative l…
56kyle Jul 24, 2025
c92fc7c
Revert "Reapply "Reapply "Reapply "docs: manually fix a few broken re…
56kyle Jul 24, 2025
1ee73fe
Revert "docs: replace terms with sphinx extlinks"
56kyle Jul 24, 2025
a31af3b
docs: replace terms with sphinx extlinks
56kyle Jul 24, 2025
931cfcb
Reapply "Reapply "Reapply "Reapply "docs: manually fix a few broken r…
56kyle Jul 24, 2025
de7c6c1
docs: manually fix ruff link
56kyle Jul 24, 2025
488e7e6
docs: fix coverage.py links
56kyle Jul 24, 2025
1184bb6
docs: add unittest to the sphinx extlinks
56kyle Jul 24, 2025
f28f683
docs: replace docker compose links that aren't properly pointing to c…
56kyle Jul 24, 2025
7f68c2e
Revert "docs: manually fix some messed up refactors"
56kyle Jul 24, 2025
a32ec19
Revert "docs: fix issues related to lost info in 04_code-linting.md"
56kyle Jul 24, 2025
88a369c
Revert "docs: update the coverage extlink"
56kyle Jul 24, 2025
6aa32cc
Revert "docs: replace coveragepy-coverage-documentation with coverage…
56kyle Jul 24, 2025
e62944a
Revert "docs: replace coveragepy-documentation with coverage.py"
56kyle Jul 24, 2025
16a73a6
Revert "docs: replace venv-tutorial with venv"
56kyle Jul 24, 2025
f36cd71
Revert "docs: add venv to the extlinks and fix some more usage errors"
56kyle Jul 24, 2025
2af41f0
Revert "docs: remove old role prefix from some broken sphinx extlinks"
56kyle Jul 24, 2025
5f3e74d
Revert "docs: adjust syntax used for extlinks to include a blank <> w…
56kyle Jul 24, 2025
02a8501
Revert "docs: mass refactor to swap role with representation where in…
56kyle Jul 24, 2025
328408f
Revert "docs: fix more extlinks"
56kyle Jul 24, 2025
58ef71b
Revert "docs: replace old extlinks usage with newer None version"
56kyle Jul 24, 2025
900d20c
Revert "docs: add missing extension for extlinks"
56kyle Jul 24, 2025
30a8c72
Revert "docs: remove faulty extension"
56kyle Jul 24, 2025
f9ac43c
Revert "docs: mass syntax refactor to hopefully solve extlink usage e…
56kyle Jul 24, 2025
78c39c2
Revert "docs: add the role extension to myst_parser"
56kyle Jul 24, 2025
af99582
Revert "build: add linkify to the myst-parser dependency"
56kyle Jul 24, 2025
6673b9f
Revert "docs: add linkify to the list of myst extensions"
56kyle Jul 24, 2025
1865026
Revert "docs: refactor more glossary links to sphinx extlinks"
56kyle Jul 24, 2025
9bebd5b
Revert "docs: fix broken pip links"
56kyle Jul 24, 2025
1efd90c
Revert "docs: replace faulty links for uv"
56kyle Jul 24, 2025
364ea06
Revert "docs: remove glossary from toctree"
56kyle Jul 24, 2025
3c6e751
Revert "docs: mass refactor of glossary links to use extlinks instead"
56kyle Jul 24, 2025
7aff40c
Revert "docs: begin to replace glossary with sphinx extlinks"
56kyle Jul 24, 2025
9be6844
Reapply "docs: swap from glossary to using sphinx extlinks"
56kyle Jul 24, 2025
c4b87f2
Reapply "docs: replace non existent pip intersphinx usage with extlink"
56kyle Jul 24, 2025
6b7595c
Revert "docs: replace non existent pip intersphinx usage with extlink"
56kyle Jul 24, 2025
1bedcee
Revert "docs: swap from glossary to using sphinx extlinks"
56kyle Jul 24, 2025
b3e7e38
Merge branch 'feature/redo-docs-refactor' into develop
56kyle Jul 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx.ext.extlinks",
"myst_parser",
"sphinx_autodoc_typehints",
"sphinx_copybutton",
Expand Down Expand Up @@ -45,6 +46,7 @@
"dollarmath",
"html_admonition",
"html_image",
"linkify",
"replacements",
"smartquotes",
"strikethrough",
Expand All @@ -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),
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started-template-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading