Skip to content

docs(feat[api-style]): Visual improvements to API docs via gp-sphinx #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tony merged 5 commits into from
Apr 11, 2026
+62 −22
Merged

docs(feat[api-style]): Visual improvements to API docs via gp-sphinx #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7c3beb
docs(feat[api-style]): Enable API badge styling via sphinx-autodoc-ap…
tony Apr 6, 2026
513e839
py(deps[dev]): Add sphinx-autodoc-api-style, bump gp-sphinx packages …
tony Apr 6, 2026
d969e50
py(deps): gp-sphinx 0.0.1a5 -> 0.0.1a6
tony Apr 7, 2026
0475c3c
py(deps): gp-sphinx 0.0.1a6 -> 0.0.1a7
tony Apr 11, 2026
3d66f56
docs(CHANGES) Visual API docs improvements via gp-sphinx
tony Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ $ uvx --from 'vcspull' --prerelease allow vcspull
_Notes on upcoming releases will be added here_
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->

### Documentation

- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#542)

## vcspull v1.58.1 (2026-03-29)

### Bug fixes
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@
source_branch="master",
light_logo="img/vcspull.svg",
dark_logo="img/vcspull-dark.svg",
extra_extensions=["sphinx_argparse_neo.exemplar"],
extra_extensions=[
"sphinx_autodoc_api_style",
"sphinx_argparse_neo.exemplar",
],
intersphinx_mapping={
"py": ("https://docs.python.org/", None),
"libvcs": ("https://libvcs.git-pull.com/", None),
Expand Down
10 changes: 6 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ vcspull = "vcspull:cli.cli"
[dependency-groups]
dev = [
# Docs
"gp-sphinx==0.0.1a1",
"sphinx-argparse-neo==0.0.1a1",
"gp-sphinx==0.0.1a7",
"sphinx-argparse-neo==0.0.1a7",
"sphinx-autodoc-api-style==0.0.1a7",
"gp-libs",
"sphinx-autobuild",
# Testing
Expand All @@ -98,8 +99,9 @@ dev = [
]

docs = [
"gp-sphinx==0.0.1a1",
"sphinx-argparse-neo==0.0.1a1",
"gp-sphinx==0.0.1a7",
"sphinx-argparse-neo==0.0.1a7",
"sphinx-autodoc-api-style==0.0.1a7",
"gp-libs",
"sphinx-autobuild",
]
Expand Down
65 changes: 48 additions & 17 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading