Skip to content

Commit 090ee3f

Browse files
committed
py(deps[dev]): Point to sphinx-autodoc-api-style from gp-sphinx api-styling
why: Use the new standalone api-style package instead of gp_sphinx.api_style. what: - Add sphinx-autodoc-api-style to dev and docs dependency groups - Add uv.sources entry for local editable install - Update docs/conf.py: gp_sphinx.api_style -> sphinx_autodoc_api_style
1 parent 2c49c0f commit 090ee3f

File tree

3 files changed

+65
-15
lines changed

3 files changed

+65
-15
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
light_logo="img/libtmux.svg",
3232
dark_logo="img/libtmux.svg",
3333
extra_extensions=[
34-
"gp_sphinx.api_style",
34+
"sphinx_autodoc_api_style",
3535
"sphinx_autodoc_pytest_fixtures",
3636
"sphinx.ext.todo",
3737
],

pyproject.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Changes = "https://github.com/tmux-python/libtmux/blob/master/CHANGES"
5353
dev = [
5454
# Docs (via gp-sphinx)
5555
"gp-sphinx>=0.0.1a1",
56+
"sphinx-autodoc-api-style>=0.0.1a1",
5657
"sphinx-autodoc-pytest-fixtures>=0.0.1a1",
5758
"sphinx-autobuild",
5859
"types-docutils",
@@ -75,6 +76,7 @@ dev = [
7576

7677
docs = [
7778
"gp-sphinx>=0.0.1a1",
79+
"sphinx-autodoc-api-style>=0.0.1a1",
7880
"sphinx-autodoc-pytest-fixtures>=0.0.1a1",
7981
"sphinx-autobuild",
8082
]
@@ -105,8 +107,9 @@ requires = ["hatchling"]
105107
build-backend = "hatchling.build"
106108

107109
[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+
gp-sphinx = { path = "../gp-sphinx/packages/gp-sphinx", editable = true }
111+
sphinx-autodoc-api-style = { path = "../gp-sphinx/packages/sphinx-autodoc-api-style", editable = true }
112+
sphinx-autodoc-pytest-fixtures = { path = "../gp-sphinx/packages/sphinx-autodoc-pytest-fixtures", editable = true }
110113

111114
[tool.mypy]
112115
strict = true

uv.lock

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

0 commit comments

Comments
 (0)