Skip to content

Commit 26605f0

Browse files
committed
!squash docs more
1 parent e49ec4c commit 26605f0

25 files changed

+189
-9
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: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,15 @@ If you need an internal API stabilized please [file an issue](https://github.com
99
:::
1010

1111
```{toctree}
12+
convert
13+
debug_info
14+
edit
15+
freeze
16+
import_config
1217
load
18+
ls
19+
shell
20+
utils
1321
```
1422

1523
## `tmuxp.cli`

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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ tmux via python API calls.
1111
internals/index
1212
cli/index
1313
workspace/index
14+
exc
15+
log
16+
plugin
17+
shell
1418
util
19+
_types
20+
types
1521
```
1622

1723
## Internals

docs/api/internals/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ If you need an internal API stabilized please [file an issue](https://github.com
1010

1111
```{toctree}
1212
config_reader
13+
types
1314
```

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.cli.types`
2+
3+
```{eval-rst}
4+
.. automodule:: tmuxp.cli.types
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: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,11 @@ If you need an internal API stabilized please [file an issue](https://github.com
99
:::
1010

1111
```{toctree}
12+
builder
13+
constants
14+
finders
15+
freezer
16+
importers
1217
loader
13-
```
14-
15-
## `tmuxp.workspace`
16-
17-
```{eval-rst}
18-
.. automodule:: tmuxp.workspace
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
18+
validation
2219
```

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)