Skip to content

Commit a5c5f12

Browse files
committed
docs: swap from myst glossary to sphinx extlinks
1 parent a622f49 commit a5c5f12

File tree

2 files changed

+59
-489
lines changed

2 files changed

+59
-489
lines changed

docs/conf.py

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
extensions = [
1717
"sphinx.ext.intersphinx",
1818
"sphinx.ext.napoleon",
19+
"sphinx.ext.extlinks",
1920
"myst_parser",
2021
"sphinx_autodoc_typehints",
2122
"sphinx_copybutton",
@@ -45,6 +46,7 @@
4546
"dollarmath",
4647
"html_admonition",
4748
"html_image",
49+
"linkify",
4850
"replacements",
4951
"smartquotes",
5052
"strikethrough",
@@ -54,6 +56,63 @@
5456
"attrs_block",
5557
]
5658

59+
extlinks = {
60+
"argocd": ("https://argo-cd.readthedocs.io/%s", None),
61+
"autopep8": ("https://pypi.org/project/autopep8/%s", None),
62+
"bandit-bandit": ("https://bandit.readthedocs.io/%s", None),
63+
"bandit": ("https://github.com/PyCQA/bandit/%s", None),
64+
"beartype": ("https://beartype.readthedocs.io/%s", None),
65+
"bitbucket-pipelines": ("https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/%s", None),
66+
"black": ("https://black.readthedocs.io/%s", None),
67+
"build": ("https://pypa-build.readthedocs.io/%s", None),
68+
"commitizen": ("https://commitizen-tools.github.io/commitizen/%s", None),
69+
"coverage.py": ("https://coverage.readthedocs.io/%s", None),
70+
"cruft": ("https://cruft.github.io/cruft/%s", None),
71+
"docker-compose": ("https://docs.docker.com/compose/%s", None),
72+
"docker": ("https://docs.docker.com/%s", None),
73+
"flake8": ("https://flake8.pycqa.org/%s", None),
74+
"flit": ("https://flit.pypa.io/%s", None),
75+
"github-actions": ("https://docs.github.com/en/actions/%s", None),
76+
"gitlab-ci": ("https://docs.gitlab.com/ee/ci/%s", None),
77+
"hatch": ("https://hatch.pypa.io/%s", None),
78+
"hatchling": ("https://hatch.pypa.io/latest/hatchling/%s", None),
79+
"helm": ("https://helm.sh/%s", None),
80+
"invoke": ("https://www.pyinvoke.org/%s", None),
81+
"isort": ("https://pycqa.github.io/isort/%s", None),
82+
"just": ("https://just.systems/%s", None),
83+
"maturin": ("https://maturin.rs/%s", None),
84+
"mkdocs": ("https://www.mkdocs.org/%s", None),
85+
"mypy": ("https://mypy-lang.org/%s", None),
86+
"myst-parser": ("https://myst-parser.readthedocs.io/%s", None),
87+
"nox": ("https://nox.thea.codes/%s", None),
88+
"pdm": ("https://pdm.fming.dev/%s", None),
89+
"pip-audit": ("https://github.com/pypa/pip-audit/%s", None),
90+
"pip": ("https://pip.pypa.io/%s", None),
91+
"pip-tools": ("https://pip-tools.readthedocs.io/%s", None),
92+
"podman": ("https://podman.io/%s", None),
93+
"poethepoet": ("https://github.com/nat-n/poethepoet/%s", None),
94+
"poetry": ("https://python-poetry.org/%s", None),
95+
"pre-commit": ("https://pre-commit.com/%s", None),
96+
"pydocstyle": ("https://www.pydocstyle.org/%s", None),
97+
"pylint": ("https://pylint.pycqa.org/%s", None),
98+
"pyright": ("https://github.com/microsoft/pyright/%s", None),
99+
"pytest": ("https://docs.pytest.org/%s", None),
100+
"pytest-pytest-cov": ("https://pytest-cov.readthedocs.io/%s", None),
101+
"pytype": ("https://github.com/google/pytype/%s", None),
102+
"ruff": ("https://docs.astral.sh/ruff/%s", None),
103+
"safety": ("https://pyup.io/%s", None),
104+
"setuptools": ("https://setuptools.pypa.io/%s", None),
105+
"sonarcloud": ("https://sonarcloud.io/%s", None),
106+
"sphinx": ("https://www.sphinx-doc.org/%s", None),
107+
"sphinxautodoctypehints": ("https://sphinx-autodoc-typehints.readthedocs.io/%s", None),
108+
"tox": ("https://tox.readthedocs.io/%s", None),
109+
"twine": ("https://twine.readthedocs.io/%s", None),
110+
"uv": ("https://docs.uv.dev/%s", None),
111+
"venv": ("https://docs.python.org/3/library/venv%s", None),
112+
"virtualenv": ("https://virtualenv.pypa.io/%s", None),
113+
"yapf": ("https://github.com/google/yapf/%s", None)
114+
}
115+
57116
intersphinx_mapping = {
58117
"python": ("https://docs.python.org/3", None),
59118
"pip": ("https://pip.pypa.io/en/stable/", None),

0 commit comments

Comments
 (0)