Skip to content

Commit

Permalink
refactor!(docs): Split out API into multiple sections
Browse files Browse the repository at this point in the history
  • Loading branch information
tony committed Dec 21, 2023
1 parent 7c530ae commit 0e0ca74
Show file tree
Hide file tree
Showing 10 changed files with 106 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/api/cli/index.md
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:
```
8 changes: 8 additions & 0 deletions docs/api/cli/sync.md
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:
```
8 changes: 8 additions & 0 deletions docs/api/config.md
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:
```
8 changes: 8 additions & 0 deletions docs/api/exc.md
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:
```
10 changes: 10 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ Be careful with these! Internal APIs are **not** covered by version policies. Th
If you need an internal API stabilized please [file an issue](https://github.com/vcs-python/vcspull/issues).
:::

```{toctree}
config
cli/index
exc
log
internals/index
util
types
```

## Exceptions

```{eval-rst}
Expand Down
14 changes: 14 additions & 0 deletions docs/api/internals/config_reader.md
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:
```
13 changes: 13 additions & 0 deletions docs/api/internals/index.md
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
```
8 changes: 8 additions & 0 deletions docs/api/log.md
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:
```
8 changes: 8 additions & 0 deletions docs/api/types.md
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:
```
8 changes: 8 additions & 0 deletions docs/api/util.md
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:
```

0 comments on commit 0e0ca74

Please sign in to comment.