Skip to content

Commit de3a4a2

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

28 files changed

+271
-139
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/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: 10 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -7,143 +7,14 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>
77
tmux via python API calls.
88
:::
99

10-
## Internals
11-
12-
:::{warning}
13-
Be careful with these! Internal APIs are **not** covered by version policies. They can break or be removed between minor versions.
14-
15-
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
16-
:::
17-
18-
```{eval-rst}
19-
.. automethod:: tmuxp.util.run_before_script
20-
```
21-
22-
```{eval-rst}
23-
.. automethod:: tmuxp.util.oh_my_zsh_auto_title
24-
```
25-
26-
```{eval-rst}
27-
.. automethod:: tmuxp.util.get_current_pane
28-
```
29-
30-
```{eval-rst}
31-
.. automethod:: tmuxp.util.get_session
32-
```
33-
34-
```{eval-rst}
35-
.. automethod:: tmuxp.util.get_window
36-
```
37-
38-
```{eval-rst}
39-
.. automethod:: tmuxp.util.get_pane
40-
```
41-
42-
## CLI
43-
44-
```{eval-rst}
45-
.. automethod:: tmuxp.cli.import_config.get_teamocil_dir
46-
```
47-
48-
```{eval-rst}
49-
.. automethod:: tmuxp.cli.import_config.get_tmuxinator_dir
50-
```
51-
52-
```{eval-rst}
53-
.. automethod:: tmuxp.cli.load.load_workspace
54-
```
55-
56-
```{eval-rst}
57-
.. automethod:: tmuxp.cli.load._reattach
58-
```
59-
60-
## Workspace files
61-
62-
### Finding
63-
64-
```{eval-rst}
65-
.. automethod:: tmuxp.workspace.finders.is_workspace_file
66-
```
67-
68-
```{eval-rst}
69-
.. automethod:: tmuxp.workspace.finders.in_dir
70-
```
71-
72-
```{eval-rst}
73-
.. automethod:: tmuxp.workspace.finders.in_cwd
74-
```
75-
76-
```{eval-rst}
77-
.. automethod:: tmuxp.workspace.finders.get_workspace_dir
78-
```
79-
80-
### Validation
81-
82-
```{eval-rst}
83-
.. autofunction:: tmuxp.workspace.validation.validate_schema
84-
```
85-
86-
### Processing
87-
88-
```{eval-rst}
89-
.. automethod:: tmuxp.workspace.loader.expandshell
90-
```
91-
92-
```{eval-rst}
93-
.. automethod:: tmuxp.workspace.loader.expand
94-
```
95-
96-
```{eval-rst}
97-
.. automethod:: tmuxp.workspace.loader.trickle
98-
```
99-
100-
## Workspace importers
101-
102-
```{eval-rst}
103-
.. automethod:: tmuxp.workspace.importers.import_teamocil
104-
```
105-
106-
```{eval-rst}
107-
.. automethod:: tmuxp.workspace.importers.import_tmuxinator
108-
```
109-
110-
## Configuration reader
111-
112-
```{eval-rst}
113-
.. automodule:: tmuxp._internal.config_reader
114-
```
115-
116-
## Workspace Builder
117-
118-
```{eval-rst}
119-
.. autoclass:: tmuxp.workspace.builder.WorkspaceBuilder
120-
:members:
121-
```
122-
123-
## Workspace Freezer
124-
125-
```{eval-rst}
126-
.. automethod:: tmuxp.workspace.freezer.freeze
127-
```
128-
129-
```{eval-rst}
130-
.. automethod:: tmuxp.workspace.freezer.inline
131-
```
132-
133-
## Exceptions
134-
135-
```{eval-rst}
136-
.. autoexception:: tmuxp.exc.EmptyWorkspaceException
137-
```
138-
139-
```{eval-rst}
140-
.. autoexception:: tmuxp.exc.WorkspaceError
141-
```
142-
143-
```{eval-rst}
144-
.. autoexception:: tmuxp.exc.BeforeLoadScriptError
145-
```
146-
147-
```{eval-rst}
148-
.. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
10+
```{toctree}
11+
internals/index
12+
cli/index
13+
workspace/index
14+
exc
15+
log
16+
plugin
17+
shell
18+
util
19+
types
14920
```

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

0 commit comments

Comments
 (0)