Skip to content

Commit 0a99edd

Browse files
committed
docs(cmd/git): add documentation for new Manager/Cmd classes
why: New git subcommand classes (branch, tag, worktree, notes, reflog) and Manager pattern classes need API documentation for discoverability. what: - Add new doc files: branch.md, tag.md, worktree.md, notes.md, reflog.md - Update remote.md, stash.md, submodule.md to include Manager classes - Update index.md toctree and exclude-members for all 19 new classes
1 parent d570744 commit 0a99edd

File tree

10 files changed

+134
-1
lines changed

10 files changed

+134
-1
lines changed

docs/cmd/git/branch.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# `branch`
2+
3+
For `git-branch(1)`.
4+
5+
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitBranchManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitBranchCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
```

docs/cmd/git/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ _Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.
1313
submodule
1414
remote
1515
stash
16+
branch
17+
tag
18+
worktree
19+
notes
20+
reflog
1621
```
1722

1823
```{eval-rst}
@@ -21,6 +26,23 @@ stash
2126
:show-inheritance:
2227
:undoc-members:
2328
:exclude-members: GitSubmoduleCmd,
29+
GitSubmoduleManager,
30+
GitSubmodule,
31+
GitSubmoduleEntryCmd,
2432
GitRemoteCmd,
25-
GitStashCmd
33+
GitRemoteManager,
34+
GitStashCmd,
35+
GitStashManager,
36+
GitStashEntryCmd,
37+
GitBranchCmd,
38+
GitBranchManager,
39+
GitTagCmd,
40+
GitTagManager,
41+
GitWorktreeCmd,
42+
GitWorktreeManager,
43+
GitNoteCmd,
44+
GitNotesManager,
45+
GitReflogEntry,
46+
GitReflogEntryCmd,
47+
GitReflogManager
2648
```

docs/cmd/git/notes.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# `notes`
2+
3+
For `git-notes(1)`.
4+
5+
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitNotesManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitNoteCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
```

docs/cmd/git/reflog.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# `reflog`
2+
3+
For `git-reflog(1)`.
4+
5+
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitReflogManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitReflogEntryCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
16+
.. autoclass:: libvcs.cmd.git.GitReflogEntry
17+
:members:
18+
:show-inheritance:
19+
:undoc-members:
20+
```

docs/cmd/git/remote.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
For `git-remote(1)`.
44

55
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitRemoteManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
611
.. autoclass:: libvcs.cmd.git.GitRemoteCmd
712
:members:
813
:show-inheritance:

docs/cmd/git/stash.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
For `git-stash(1)`.
44

55
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitStashManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitStashEntryCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
616
.. autoclass:: libvcs.cmd.git.GitStashCmd
717
:members:
818
:show-inheritance:

docs/cmd/git/submodule.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@
33
For `git-submodule(1)`.
44

55
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitSubmoduleManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitSubmodule
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
16+
.. autoclass:: libvcs.cmd.git.GitSubmoduleEntryCmd
17+
:members:
18+
:show-inheritance:
19+
:undoc-members:
20+
621
.. autoclass:: libvcs.cmd.git.GitSubmoduleCmd
722
:members:
823
:show-inheritance:

docs/cmd/git/tag.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# `tag`
2+
3+
For `git-tag(1)`.
4+
5+
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitTagManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitTagCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
```

docs/cmd/git/worktree.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# `worktree`
2+
3+
For `git-worktree(1)`.
4+
5+
```{eval-rst}
6+
.. autoclass:: libvcs.cmd.git.GitWorktreeManager
7+
:members:
8+
:show-inheritance:
9+
:undoc-members:
10+
11+
.. autoclass:: libvcs.cmd.git.GitWorktreeCmd
12+
:members:
13+
:show-inheritance:
14+
:undoc-members:
15+
```

src/libvcs/cmd/git.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ def __init__(
7070
''
7171
7272
# Additional tests
73+
7374
>>> git.remotes.get(remote_name='my_remote').remove()
7475
''
7576
>>> git.remotes.show()

0 commit comments

Comments
 (0)