Skip to content

Commit 3aa9171

Browse files
committed
docs: Use sphinx-autoapi's autoapimodule directive for ToC
1 parent 58488ba commit 3aa9171

File tree

8 files changed

+10
-60
lines changed

8 files changed

+10
-60
lines changed

docs/cmd/git.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,7 @@ Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.h
77
[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
88

99
```{eval-rst}
10-
.. autosummary::
11-
:recursive:
12-
13-
libvcs.cmd.git.Git
14-
```
15-
16-
```{eval-rst}
17-
.. automodule:: libvcs.cmd.git
10+
.. autoapimodule:: libvcs.cmd.git
1811
:members:
1912
:show-inheritance:
2013
:undoc-members:

docs/cmd/hg.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
For mercurial, aka `hg(1)`.
44

55
```{eval-rst}
6-
.. autosummary::
7-
:recursive:
8-
9-
libvcs.cmd.hg.Hg
10-
```
11-
12-
```{eval-rst}
13-
.. automodule:: libvcs.cmd.hg
6+
.. autoapimodule:: libvcs.cmd.hg
147
:members:
158
:show-inheritance:
169
:undoc-members:

docs/cmd/svn.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
For subversion, aka `svn(1)`
44

55
```{eval-rst}
6-
.. autosummary::
7-
:recursive:
8-
9-
libvcs.cmd.svn.Svn
10-
```
11-
12-
```{eval-rst}
13-
.. automodule:: libvcs.cmd.svn
6+
.. autoapimodule:: libvcs.cmd.svn
147
:members:
158
:show-inheritance:
169
:undoc-members:

docs/projects/base.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,7 @@ Base objects / classes for projects.
55
Adding your own VCS / Extending libvcs can be done through subclassing `BaseProject`.
66

77
```{eval-rst}
8-
.. autosummary::
9-
:recursive:
10-
11-
libvcs.projects.base.BaseProject
12-
```
13-
14-
```{eval-rst}
15-
.. automodule:: libvcs.projects.base
8+
.. autoapimodule:: libvcs.projects.base
169
:members:
1710
:show-inheritance:
1811
```

docs/projects/git.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,7 @@ Compare to:
88
[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
99

1010
```{eval-rst}
11-
.. autosummary::
12-
:recursive:
13-
14-
libvcs.projects.git.GitRemote
15-
libvcs.projects.git.GitProject
16-
```
17-
18-
```{eval-rst}
19-
.. automodule:: libvcs.projects.git
11+
.. autoapimodule:: libvcs.projects.git
2012
:members:
2113
:show-inheritance:
2214
:undoc-members:

docs/projects/hg.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
For mercurial, aka `hg(1)`.
44

55
```{eval-rst}
6-
.. autosummary::
7-
:recursive:
8-
9-
libvcs.projects.hg.MercurialProject
10-
```
11-
12-
```{eval-rst}
13-
.. automodule:: libvcs.projects.hg
6+
.. autoapimodule:: libvcs.projects.hg
147
:members:
158
:show-inheritance:
169
:undoc-members:

docs/projects/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Helper methods are available in `libvcs.shortcuts` which can return a repo objec
2929
entry-point.
3030

3131
```{eval-rst}
32-
.. automodule:: libvcs.shortcuts
32+
.. autoapimodule:: libvcs.shortcuts
3333
:members:
3434
```
3535

@@ -38,13 +38,13 @@ See examples below of git, mercurial, and subversion.
3838
## Constants
3939

4040
```{eval-rst}
41-
.. automodule:: libvcs.projects.constants
41+
.. autoapimodule:: libvcs.projects.constants
4242
:members:
4343
```
4444

4545
## Utility stuff
4646

4747
```{eval-rst}
48-
.. automodule:: libvcs.cmd.core
48+
.. autoapimodule:: libvcs.cmd.core
4949
:members:
5050
```

docs/projects/svn.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
For subversion, aka `svn(1)`
44

55
```{eval-rst}
6-
.. autosummary::
7-
:recursive:
8-
9-
libvcs.projects.svn.SubversionProject
10-
```
11-
12-
```{eval-rst}
13-
.. automodule:: libvcs.projects.svn
6+
.. autoapimodule:: libvcs.projects.svn
147
:members:
158
:show-inheritance:
169
:undoc-members:

0 commit comments

Comments
 (0)