Skip to content

Commit e49ec4c

Browse files
committed
refactor!(docs): Split out API into multiple sections
1 parent 049cbde commit e49ec4c

File tree

8 files changed

+102
-0
lines changed

8 files changed

+102
-0
lines changed

docs/api/cli/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(api_cli)=
2+
3+
# CLI
4+
5+
:::{warning}
6+
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions!
7+
8+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
9+
:::
10+
11+
```{toctree}
12+
load
13+
```
14+
15+
## `tmuxp.cli`
16+
17+
```{eval-rst}
18+
.. automodule:: tmuxp.cli
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
```

docs/api/cli/load.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# tmuxp load - `tmuxp.cli.load`
2+
3+
```{eval-rst}
4+
.. automodule:: tmuxp.cli.load
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
```

docs/api/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>
77
tmux via python API calls.
88
:::
99

10+
```{toctree}
11+
internals/index
12+
cli/index
13+
workspace/index
14+
util
15+
```
16+
1017
## Internals
1118

1219
:::{warning}

docs/api/internals/config_reader.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Config reader - `tmuxp._internal.config_reader`
2+
3+
:::{warning}
4+
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions!
5+
6+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
7+
:::
8+
9+
```{eval-rst}
10+
.. automodule:: tmuxp._internal.config_reader
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
```

docs/api/internals/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
(internals)=
2+
3+
# Internals
4+
5+
:::{warning}
6+
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions!
7+
8+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
9+
:::
10+
11+
```{toctree}
12+
config_reader
13+
```

docs/api/util.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Utilities - `tmuxp.util`
2+
3+
```{eval-rst}
4+
.. automodule:: tmuxp.util
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
```

docs/api/workspace/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(workspace)=
2+
3+
# Workspace
4+
5+
:::{warning}
6+
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions!
7+
8+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
9+
:::
10+
11+
```{toctree}
12+
loader
13+
```
14+
15+
## `tmuxp.workspace`
16+
17+
```{eval-rst}
18+
.. automodule:: tmuxp.workspace
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
```

docs/api/workspace/loader.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Loader - `tmuxp.workspace.loader`
2+
3+
```{eval-rst}
4+
.. automodule:: tmuxp.workspace.loader
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
```

0 commit comments

Comments
 (0)