Skip to content

Commit c044d5a

Browse files
committed
docs(API): Add API page
1 parent f34599b commit c044d5a

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/api.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
(api)=
2+
3+
# API Reference
4+
5+
:::{seealso}
6+
See {ref}`libvcs's API <libvcs:api>` and {ref}`Quickstart <libvcs:quickstart>` to see how you can control
7+
VCS systems via python API calls.
8+
:::
9+
10+
## Internals
11+
12+
:::{warning}
13+
These APIs are purely internal not covered by versioning policies, they can and will break between versions.
14+
If you need an internal API stabilized please [file an issue](https://github.com/vcs-python/libvcs/issues).
15+
:::
16+
17+
## Exceptions
18+
19+
```{eval-rst}
20+
.. autoexception:: vcspull.exc.VCSPullException
21+
```
22+
23+
```{eval-rst}
24+
.. autoexception:: vcspull.exc.MultipleConfigWarning
25+
```

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ quickstart
2121
configuration
2222
config-generation
2323
cli
24+
api
2425
developing
2526
history
2627

0 commit comments

Comments
 (0)