1
1
# API Reference
2
2
3
- ## Creating a repo object
3
+ ## Create from VCS url
4
4
5
5
Helper methods are available in `` libvcs.shortcuts `` which
6
6
can return a repo object from a single entry-point.
7
7
8
8
``` eval_rst
9
- .. autofunction:: libvcs.shortcuts.create_repo
10
-
11
- .. autofunction:: libvcs.shortcuts.create_repo_from_pip_url
9
+ .. automodule:: libvcs.shortcuts
10
+ :members:
12
11
```
13
12
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
-
20
13
See examples below of git, mercurial, and subversion.
21
14
15
+ ## Instantiating a repo by hand
16
+
22
17
### Git
23
18
24
19
``` eval_rst
25
- .. autoclass :: libvcs.git.GitRepo
20
+ .. automodule :: libvcs.git
26
21
:members:
27
22
:show-inheritance:
28
-
29
- .. autoclass:: libvcs.git.GitRemote
30
- :members:
31
- :show-inheritance:
32
-
33
- .. autofunction:: libvcs.git.extract_status
34
23
```
35
24
36
25
### Mercurial
37
26
38
27
aka `` hg(1) ``
39
28
40
29
``` eval_rst
41
- .. autoclass :: libvcs.hg.MercurialRepo
30
+ .. automodule :: libvcs.hg
42
31
:members:
43
32
:show-inheritance:
44
33
```
@@ -48,19 +37,19 @@ aka ``hg(1)``
48
37
aka `` svn(1) ``
49
38
50
39
``` eval_rst
51
- .. autoclass :: libvcs.svn.SubversionRepo
40
+ .. automodule :: libvcs.svn
52
41
:members:
53
42
:show-inheritance:
54
43
```
55
44
56
- ### Adding your own VCS
45
+ ### Under the hood
57
46
58
- Extending libvcs can be done through subclassing `` BaseRepo `` .
47
+ Adding your own VCS / Extending libvcs can be done through subclassing `` BaseRepo `` .
59
48
60
49
``` eval_rst
61
- .. autoclass :: libvcs.base.BaseRepo
62
- :members:
63
- :show-inheritance:
50
+ .. automodule :: libvcs.base
51
+ :members:
52
+ :show-inheritance:
64
53
```
65
54
66
55
### Utility stuff
0 commit comments