Skip to content

Commit cf751f3

Browse files
committed
style(deps[docs]): Integrate sphinx-autodoc-api-style, bump gp-sphinx packages to 0.0.1a5
why: Align docs stack with latest gp-sphinx workspace releases and enable API badges what: - Pin gp-sphinx, sphinx-argparse-neo, and sphinx-autodoc-api-style to 0.0.1a5 - Register sphinx_autodoc_api_style in docs/conf.py extra_extensions - Regenerate uv.lock
1 parent 2b17f77 commit cf751f3

3 files changed

Lines changed: 44 additions & 21 deletions

File tree

docs/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@
3131
source_branch="master",
3232
light_logo="img/tmuxp.svg",
3333
dark_logo="img/tmuxp.svg",
34-
extra_extensions=["aafig", "sphinx_argparse_neo.exemplar"],
34+
extra_extensions=[
35+
"sphinx_autodoc_api_style",
36+
"aafig",
37+
"sphinx_argparse_neo.exemplar",
38+
],
3539
intersphinx_mapping={
3640
"python": ("https://docs.python.org/", None),
3741
"libtmux": ("https://libtmux.git-pull.com/", None),

pyproject.toml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ dev = [
5757
# Docs
5858
"aafigure", # https://launchpad.net/aafigure
5959
"pillow", # https://pillow.readthedocs.io/
60-
"gp-sphinx==0.0.1a0", # https://gp-sphinx.git-pull.com/
61-
"sphinx-argparse-neo==0.0.1a0", # https://gp-sphinx.git-pull.com/
60+
"gp-sphinx==0.0.1a5", # https://gp-sphinx.git-pull.com/
61+
"sphinx-argparse-neo==0.0.1a5", # https://gp-sphinx.git-pull.com/
62+
"sphinx-autodoc-api-style==0.0.1a5",
6263
"gp-libs", # https://gp-libs.git-pull.com/
6364
"sphinx-autobuild", # https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html
6465
# Testing
@@ -82,8 +83,9 @@ dev = [
8283
docs = [
8384
"aafigure", # https://launchpad.net/aafigure
8485
"pillow", # https://pillow.readthedocs.io/
85-
"gp-sphinx==0.0.1a0", # https://gp-sphinx.git-pull.com/
86-
"sphinx-argparse-neo==0.0.1a0", # https://gp-sphinx.git-pull.com/
86+
"gp-sphinx==0.0.1a5", # https://gp-sphinx.git-pull.com/
87+
"sphinx-argparse-neo==0.0.1a5", # https://gp-sphinx.git-pull.com/
88+
"sphinx-autodoc-api-style==0.0.1a5",
8789
"gp-libs", # https://gp-libs.git-pull.com/
8890
"sphinx-autobuild", # https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html
8991
]

uv.lock

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

0 commit comments

Comments
 (0)