Skip to content

Commit c32d8cc

Browse files
committed
docs(api): Fix hg
1 parent 26c0777 commit c32d8cc

File tree

1 file changed

+13
-24
lines changed

1 file changed

+13
-24
lines changed

docs/api.md

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,33 @@
11
# API Reference
22

3-
## Creating a repo object
3+
## Create from VCS url
44

55
Helper methods are available in ``libvcs.shortcuts`` which
66
can return a repo object from a single entry-point.
77

88
```eval_rst
9-
.. autofunction:: libvcs.shortcuts.create_repo
10-
11-
.. autofunction:: libvcs.shortcuts.create_repo_from_pip_url
9+
.. automodule:: libvcs.shortcuts
10+
:members:
1211
```
1312

14-
## Instantiating a repo by hand
15-
16-
Tools like :func:`libvcs.shortcuts.create_repo` and
17-
:func:`libvcs.shortcuts.create_repo_from_pip_url` are just wrappers
18-
around instantiated these classes.
19-
2013
See examples below of git, mercurial, and subversion.
2114

15+
## Instantiating a repo by hand
16+
2217
### Git
2318

2419
```eval_rst
25-
.. autoclass:: libvcs.git.GitRepo
20+
.. automodule:: libvcs.git
2621
:members:
2722
:show-inheritance:
28-
29-
.. autoclass:: libvcs.git.GitRemote
30-
:members:
31-
:show-inheritance:
32-
33-
.. autofunction:: libvcs.git.extract_status
3423
```
3524

3625
### Mercurial
3726

3827
aka ``hg(1)``
3928

4029
```eval_rst
41-
.. autoclass:: libvcs.hg.MercurialRepo
30+
.. automodule:: libvcs.hg
4231
:members:
4332
:show-inheritance:
4433
```
@@ -48,19 +37,19 @@ aka ``hg(1)``
4837
aka ``svn(1)``
4938

5039
```eval_rst
51-
.. autoclass:: libvcs.svn.SubversionRepo
40+
.. automodule:: libvcs.svn
5241
:members:
5342
:show-inheritance:
5443
```
5544

56-
### Adding your own VCS
45+
### Under the hood
5746

58-
Extending libvcs can be done through subclassing ``BaseRepo``.
47+
Adding your own VCS / Extending libvcs can be done through subclassing ``BaseRepo``.
5948

6049
```eval_rst
61-
.. autoclass:: libvcs.base.BaseRepo
62-
:members:
63-
:show-inheritance:
50+
.. automodule:: libvcs.base
51+
:members:
52+
:show-inheritance:
6453
```
6554

6655
### Utility stuff

0 commit comments

Comments
 (0)