Skip to content

Commit 2c49c0f

Browse files
committed
docs(feat[api-style]): Enable API badge styling from gp-sphinx
why: The new gp_sphinx.api_style extension adds type and modifier badges to autodoc entries, matching the visual language of sphinx-autodoc-pytest-fixtures. what: - Add gp_sphinx.api_style to extra_extensions in docs/conf.py - Point gp-sphinx and sphinx-autodoc-pytest-fixtures to api-styling branch - Relax version pins from ==0.0.1a1 to >=0.0.1a1
1 parent fd2b607 commit 2c49c0f

File tree

3 files changed

+25
-33
lines changed

3 files changed

+25
-33
lines changed

docs/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@
3030
source_branch="master",
3131
light_logo="img/libtmux.svg",
3232
dark_logo="img/libtmux.svg",
33-
extra_extensions=["sphinx_autodoc_pytest_fixtures", "sphinx.ext.todo"],
33+
extra_extensions=[
34+
"gp_sphinx.api_style",
35+
"sphinx_autodoc_pytest_fixtures",
36+
"sphinx.ext.todo",
37+
],
3438
intersphinx_mapping={
3539
"python": ("https://docs.python.org/", None),
3640
"pytest": ("https://docs.pytest.org/en/stable/", None),

pyproject.toml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Changes = "https://github.com/tmux-python/libtmux/blob/master/CHANGES"
5252
[dependency-groups]
5353
dev = [
5454
# Docs (via gp-sphinx)
55-
"gp-sphinx==0.0.1a1",
56-
"sphinx-autodoc-pytest-fixtures==0.0.1a1",
55+
"gp-sphinx>=0.0.1a1",
56+
"sphinx-autodoc-pytest-fixtures>=0.0.1a1",
5757
"sphinx-autobuild",
5858
"types-docutils",
5959
# Testing
@@ -74,8 +74,8 @@ dev = [
7474
]
7575

7676
docs = [
77-
"gp-sphinx==0.0.1a1",
78-
"sphinx-autodoc-pytest-fixtures==0.0.1a1",
77+
"gp-sphinx>=0.0.1a1",
78+
"sphinx-autodoc-pytest-fixtures>=0.0.1a1",
7979
"sphinx-autobuild",
8080
]
8181
testing = [
@@ -104,6 +104,10 @@ libtmux = "libtmux.pytest_plugin"
104104
requires = ["hatchling"]
105105
build-backend = "hatchling.build"
106106

107+
[tool.uv.sources]
108+
gp-sphinx = { git = "https://github.com/git-pull/gp-sphinx.git", branch = "api-styling", subdirectory = "packages/gp-sphinx" }
109+
sphinx-autodoc-pytest-fixtures = { git = "https://github.com/git-pull/gp-sphinx.git", branch = "api-styling", subdirectory = "packages/sphinx-autodoc-pytest-fixtures" }
110+
107111
[tool.mypy]
108112
strict = true
109113
python_version = "3.10"

uv.lock

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

0 commit comments

Comments
 (0)