Skip to content

Commit 0ca7749

Browse files
committed
py(deps[docs]): add sphinx-design, annotate doc dependencies with site URLs
why: sphinx-design is needed for grid cards in the documentation landing pages and section indexes. Doc-site URLs added as inline comments for quick reference when managing dependencies. what: - Add sphinx-design to docs and dev dependency groups - Annotate all doc dependencies with their documentation URLs
1 parent 9f0bc60 commit 0ca7749

File tree

2 files changed

+64
-25
lines changed

2 files changed

+64
-25
lines changed

pyproject.toml

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,18 @@ Changes = "https://github.com/tmux-python/libtmux/blob/master/CHANGES"
5252
[dependency-groups]
5353
dev = [
5454
# Docs
55-
"sphinx<9",
56-
"furo",
57-
"gp-libs",
58-
"sphinx-autobuild",
59-
"sphinx-autodoc-typehints",
60-
"sphinx-inline-tabs",
61-
"sphinxext-opengraph",
62-
"sphinx-copybutton",
63-
"sphinxext-rediraffe",
64-
"myst-parser",
65-
"linkify-it-py",
55+
"sphinx<9", # https://www.sphinx-doc.org/
56+
"furo", # https://pradyunsg.me/furo/
57+
"gp-libs", # https://gp-libs.git-pull.com/
58+
"sphinx-autobuild", # https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html
59+
"sphinx-autodoc-typehints", # https://sphinx-autodoc-typehints.readthedocs.io/
60+
"sphinx-inline-tabs", # https://sphinx-inline-tabs.readthedocs.io/
61+
"sphinxext-opengraph", # https://sphinxext-opengraph.readthedocs.io/
62+
"sphinx-copybutton", # https://sphinx-copybutton.readthedocs.io/
63+
"sphinxext-rediraffe", # https://sphinxext-rediraffe.readthedocs.io/
64+
"sphinx-design", # https://sphinx-design.readthedocs.io/
65+
"myst-parser", # https://myst-parser.readthedocs.io/
66+
"linkify-it-py", # https://github.com/tsutsu3/linkify-it-py
6667
# Testing
6768
"typing-extensions; python_version < '3.11'",
6869
"gp-libs",
@@ -81,17 +82,18 @@ dev = [
8182
]
8283

8384
docs = [
84-
"sphinx<9",
85-
"furo",
86-
"gp-libs",
87-
"sphinx-autobuild",
88-
"sphinx-autodoc-typehints",
89-
"sphinx-inline-tabs",
90-
"sphinxext-opengraph",
91-
"sphinx-copybutton",
92-
"sphinxext-rediraffe",
93-
"myst-parser",
94-
"linkify-it-py",
85+
"sphinx<9", # https://www.sphinx-doc.org/
86+
"furo", # https://pradyunsg.me/furo/
87+
"gp-libs", # https://gp-libs.git-pull.com/
88+
"sphinx-autobuild", # https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html
89+
"sphinx-autodoc-typehints", # https://sphinx-autodoc-typehints.readthedocs.io/
90+
"sphinx-inline-tabs", # https://sphinx-inline-tabs.readthedocs.io/
91+
"sphinxext-opengraph", # https://sphinxext-opengraph.readthedocs.io/
92+
"sphinx-copybutton", # https://sphinx-copybutton.readthedocs.io/
93+
"sphinxext-rediraffe", # https://sphinxext-rediraffe.readthedocs.io/
94+
"sphinx-design", # https://sphinx-design.readthedocs.io/
95+
"myst-parser", # https://myst-parser.readthedocs.io/
96+
"linkify-it-py", # https://github.com/tsutsu3/linkify-it-py
9597
]
9698
testing = [
9799
"typing-extensions; python_version < '3.11'",

uv.lock

Lines changed: 40 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)