Skip to content

Commit fc2b76f

Browse files
committed
docs: Add cmd
1 parent 95007f2 commit fc2b76f

File tree

5 files changed

+81
-0
lines changed

5 files changed

+81
-0
lines changed

docs/cmd/git.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# `libvcs.cmd.git`
2+
3+
For `git(1)`.
4+
5+
Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.html#git-module),
6+
[`salt.modules.git`](https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html),
7+
[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
8+
9+
```{eval-rst}
10+
.. autosummary::
11+
:recursive:
12+
13+
libvcs.cmd.git.Git
14+
```
15+
16+
```{eval-rst}
17+
.. automodule:: libvcs.cmd.git
18+
:members:
19+
:show-inheritance:
20+
:undoc-members:
21+
:inherited-members:
22+
```

docs/cmd/hg.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# `libvcs.cmd.hg`
2+
3+
For mercurial, aka `hg(1)`.
4+
5+
```{eval-rst}
6+
.. autosummary::
7+
:recursive:
8+
9+
libvcs.cmd.hg.Hg
10+
```
11+
12+
```{eval-rst}
13+
.. automodule:: libvcs.cmd.hg
14+
:members:
15+
:show-inheritance:
16+
:undoc-members:
17+
:inherited-members:
18+
```

docs/cmd/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(cmd)=
2+
3+
# `libvcs.cmd`
4+
5+
Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.html#git-module),
6+
[`salt.modules.git`](https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html),
7+
[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
8+
9+
:::{warning}
10+
11+
All APIs are considered experimental and subject to break pre-1.0. They can and will break between
12+
versions.
13+
14+
:::
15+
16+
```{toctree}
17+
:caption: API
18+
19+
git
20+
hg
21+
svn
22+
```

docs/cmd/svn.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# `libvcs.cmd.svn`
2+
3+
For subversion, aka `svn(1)`
4+
5+
```{eval-rst}
6+
.. autosummary::
7+
:recursive:
8+
9+
libvcs.cmd.svn.Svn
10+
```
11+
12+
```{eval-rst}
13+
.. automodule:: libvcs.cmd.svn
14+
:members:
15+
:show-inheritance:
16+
:undoc-members:
17+
:inherited-members:
18+
```

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
:hidden:
1010
1111
quickstart
12+
cmd/index
1213
states/index
1314
```
1415

0 commit comments

Comments
 (0)