Skip to content

Commit 127bae9

Browse files
authored
docs(gp-sphinx) Bump gp-sphinx to v0.0.1a8 (#54)
Adopt gp-sphinx v0.0.1a8: ArgparseDomain, gp-sphinx-* CSS namespace, sphinx>=8.1 floor, typed env.domains.* accessors, and package renames (sphinx-autodoc-layout → sphinx-ux-autodoc-layout, sphinx-autodoc-badges → sphinx-ux-badges). Also renames sphinx-argparse-neo==0.0.1a7 → sphinx-autodoc-argparse==0.0.1a8 (extension path updated in docs/conf.py). Preserves two doc-fix commits carried forward from the previous autodoc-improvements branch (grid-item-card ref-links; manual "Usage" heading rename to avoid argparse id collision). See also: https://pypi.org/project/gp-sphinx/0.0.1a8/
2 parents cb4dee9 + eafcc21 commit 127bae9

5 files changed

Lines changed: 78 additions & 78 deletions

File tree

CHANGES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ _Notes on upcoming releases will be added here_
3636
### Documentation
3737

3838
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#53)
39+
- Bump gp-sphinx docs stack to v0.0.1a8 (#54)
3940

4041

4142
### CLI

docs/cli/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
:gutter: 2 2 3 3
77

88
:::{grid-item-card} g
9-
:link: #command
10-
:link-type: url
9+
:link: cli-main
10+
:link-type: ref
1111
Proxy to your repo's VCS command.
1212
:::
1313

1414
:::{grid-item-card} Supported VCS
15-
:link: #supported-vcs
16-
:link-type: url
15+
:link: cli-supported-vcs
16+
:link-type: ref
1717
git, svn, and hg detection.
1818
:::
1919

@@ -31,7 +31,7 @@ When you run `g`, it:
3131

3232
**Note:** `--version`/`-V` is handled by g itself rather than passed to the VCS.
3333

34-
## Usage
34+
## Usage examples
3535

3636
```console
3737
$ g status
@@ -65,6 +65,8 @@ $ g log --oneline -10
6565
$ g diff HEAD~1
6666
```
6767

68+
(cli-supported-vcs)=
69+
6870
## Supported VCS
6971

7072
| Directory marker | VCS command |

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
extra_extensions=[
3434
"sphinx_autodoc_api_style",
3535
"sphinx.ext.todo",
36-
"sphinx_argparse_neo.exemplar",
36+
"sphinx_autodoc_argparse.exemplar",
3737
],
3838
intersphinx_mapping={
3939
"py": ("https://docs.python.org/", None),

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ dev = [
5959
# Docs
6060
"aafigure",
6161
"pillow",
62-
"gp-sphinx==0.0.1a7",
63-
"sphinx-argparse-neo==0.0.1a7",
64-
"sphinx-autodoc-api-style==0.0.1a7",
62+
"gp-sphinx==0.0.1a8",
63+
"sphinx-autodoc-argparse==0.0.1a8",
64+
"sphinx-autodoc-api-style==0.0.1a8",
6565
"gp-libs",
6666
"sphinx-autobuild",
6767
# Testing
@@ -85,9 +85,9 @@ dev = [
8585
docs = [
8686
"aafigure",
8787
"pillow",
88-
"gp-sphinx==0.0.1a7",
89-
"sphinx-argparse-neo==0.0.1a7",
90-
"sphinx-autodoc-api-style==0.0.1a7",
88+
"gp-sphinx==0.0.1a8",
89+
"sphinx-autodoc-argparse==0.0.1a8",
90+
"sphinx-autodoc-api-style==0.0.1a8",
9191
"gp-libs",
9292
"sphinx-autobuild",
9393
]

0 commit comments

Comments
 (0)