Skip to content

Commit a144add

Browse files
committed
refactor!(docs): Split out API into multiple sections
1 parent 22f3ca5 commit a144add

29 files changed

+281
-0
lines changed

docs/api/cli/convert.md

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

docs/api/cli/debug_info.md

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

docs/api/cli/edit.md

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

docs/api/cli/freeze.md

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

docs/api/cli/import_config.md

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

docs/api/cli/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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+
convert
13+
debug_info
14+
edit
15+
freeze
16+
import_config
17+
load
18+
ls
19+
shell
20+
utils
21+
```
22+
23+
## `tmuxp.cli`
24+
25+
```{eval-rst}
26+
.. automodule:: tmuxp.cli
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
```

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/cli/ls.md

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

docs/api/cli/shell.md

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

docs/api/cli/types.md

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

docs/api/cli/utils.md

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

docs/api/exc.md

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

docs/api/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ 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+
exc
15+
log
16+
plugin
17+
shell
18+
util
19+
types
20+
```
21+
1022
## Internals
1123

1224
:::{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: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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+
types
14+
```

docs/api/internals/types.md

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

docs/api/log.md

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

docs/api/plugin.md

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

docs/api/shell.md

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

docs/api/types.md

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

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/builder.md

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

docs/api/workspace/constants.md

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

docs/api/workspace/finders.md

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

docs/api/workspace/freezer.md

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

docs/api/workspace/importers.md

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

docs/api/workspace/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
builder
13+
constants
14+
finders
15+
freezer
16+
importers
17+
loader
18+
validation
19+
```

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+
```

docs/api/workspace/validation.md

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

0 commit comments

Comments
 (0)