-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor!(docs): Split out API into multiple sections
- Loading branch information
Showing
10 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
(api_cli)= | ||
|
||
(api_commands)= | ||
|
||
# CLI | ||
|
||
```{toctree} | ||
:caption: General commands | ||
:maxdepth: 1 | ||
sync | ||
``` | ||
|
||
## vcspull CLI - `vcspull.cli` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.cli | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# vcspull sync - `vcspull.cli.sync` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.cli.sync | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Config - `vcspull.config` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.config | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Exceptions - `vcspull.exc` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.exc | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Config reader - `vcspull._internal.config_reader` | ||
|
||
:::{warning} | ||
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions! | ||
|
||
If you need an internal API stabilized please [file an issue](https://github.com/vcs-python/vcspull/issues). | ||
::: | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull._internal.config_reader | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
(internals)= | ||
|
||
# Internals | ||
|
||
:::{warning} | ||
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions! | ||
|
||
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues). | ||
::: | ||
|
||
```{toctree} | ||
config_reader | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Logging - `vcspull.log` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.log | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Typings - `vcspull.types` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.types | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Utilities - `vcspull.util` | ||
|
||
```{eval-rst} | ||
.. automodule:: vcspull.util | ||
:members: | ||
:show-inheritance: | ||
:undoc-members: | ||
``` |