refactor!(docs): Split out API into multiple sections

tony · tony · commit de3a4a256d84 · 2023-12-21T13:43:01.000-06:00
diff --git a/docs/api/cli/convert.md b/docs/api/cli/convert.md
@@ -0,0 +1,8 @@
+# tmuxp convert - `tmuxp.cli.convert`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.convert
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/debug_info.md b/docs/api/cli/debug_info.md
@@ -0,0 +1,8 @@
+# tmuxp debug-info - `tmuxp.cli.debug_info`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.debug_info
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/edit.md b/docs/api/cli/edit.md
@@ -0,0 +1,8 @@
+# tmuxp edit - `tmuxp.cli.edit`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.edit
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/freeze.md b/docs/api/cli/freeze.md
@@ -0,0 +1,8 @@
+# tmuxp freeze - `tmuxp.cli.freeze`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.freeze
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/import_config.md b/docs/api/cli/import_config.md
@@ -0,0 +1,8 @@
+# tmuxp import - `tmuxp.cli.import_config`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.import_config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/index.md b/docs/api/cli/index.md
@@ -0,0 +1,30 @@
+(api_cli)=
+
+# CLI
+
+:::{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}
+convert
+debug_info
+edit
+freeze
+import_config
+load
+ls
+shell
+utils
+```
+
+## `tmuxp.cli`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/load.md b/docs/api/cli/load.md
@@ -0,0 +1,8 @@
+# tmuxp load - `tmuxp.cli.load`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.load
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/ls.md b/docs/api/cli/ls.md
@@ -0,0 +1,8 @@
+# tmuxp ls - `tmuxp.cli.ls`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.ls
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/shell.md b/docs/api/cli/shell.md
@@ -0,0 +1,8 @@
+# tmuxp shell - `tmuxp.cli.shell`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.shell
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/cli/utils.md b/docs/api/cli/utils.md
@@ -0,0 +1,8 @@
+# CLI utilities - `tmuxp.cli.utils`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.utils
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/exc.md b/docs/api/exc.md
@@ -0,0 +1,8 @@
+# Exceptions - `tmuxp.exc`
+
+```{eval-rst}
+.. automodule:: tmuxp.exc
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -7,143 +7,14 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>
 tmux via python API calls.
 :::
 
-## 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).
-:::
-
-```{eval-rst}
-.. automethod:: tmuxp.util.run_before_script
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.util.oh_my_zsh_auto_title
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.util.get_current_pane
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.util.get_session
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.util.get_window
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.util.get_pane
-```
-
-## CLI
-
-```{eval-rst}
-.. automethod:: tmuxp.cli.import_config.get_teamocil_dir
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.cli.import_config.get_tmuxinator_dir
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.cli.load.load_workspace
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.cli.load._reattach
-```
-
-## Workspace files
-
-### Finding
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.finders.is_workspace_file
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.finders.in_dir
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.finders.in_cwd
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.finders.get_workspace_dir
-```
-
-### Validation
-
-```{eval-rst}
-.. autofunction:: tmuxp.workspace.validation.validate_schema
-```
-
-### Processing
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.loader.expandshell
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.loader.expand
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.loader.trickle
-```
-
-## Workspace importers
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.importers.import_teamocil
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.importers.import_tmuxinator
-```
-
-## Configuration reader
-
-```{eval-rst}
-.. automodule:: tmuxp._internal.config_reader
-```
-
-## Workspace Builder
-
-```{eval-rst}
-.. autoclass:: tmuxp.workspace.builder.WorkspaceBuilder
-   :members:
-```
-
-## Workspace Freezer
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.freezer.freeze
-```
-
-```{eval-rst}
-.. automethod:: tmuxp.workspace.freezer.inline
-```
-
-## Exceptions
-
-```{eval-rst}
-.. autoexception:: tmuxp.exc.EmptyWorkspaceException
-```
-
-```{eval-rst}
-.. autoexception:: tmuxp.exc.WorkspaceError
-```
-
-```{eval-rst}
-.. autoexception:: tmuxp.exc.BeforeLoadScriptError
-```
-
-```{eval-rst}
-.. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
+```{toctree}
+internals/index
+cli/index
+workspace/index
+exc
+log
+plugin
+shell
+util
+types
 ```
diff --git a/docs/api/internals/config_reader.md b/docs/api/internals/config_reader.md
@@ -0,0 +1,14 @@
+# Config reader - `tmuxp._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/tmux-python/tmuxp/issues).
+:::
+
+```{eval-rst}
+.. automodule:: tmuxp._internal.config_reader
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/internals/index.md b/docs/api/internals/index.md
@@ -0,0 +1,14 @@
+(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
+types
+```
diff --git a/docs/api/internals/types.md b/docs/api/internals/types.md
@@ -0,0 +1,8 @@
+# Typings - `tmuxp._internal.types`
+
+```{eval-rst}
+.. automodule:: tmuxp._internal.types
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/log.md b/docs/api/log.md
@@ -0,0 +1,8 @@
+# Logging - `tmuxp.log`
+
+```{eval-rst}
+.. automodule:: tmuxp.log
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/plugin.md b/docs/api/plugin.md
@@ -0,0 +1,8 @@
+# Plugin - `tmuxp.plugin`
+
+```{eval-rst}
+.. automodule:: tmuxp.plugin
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/shell.md b/docs/api/shell.md
@@ -0,0 +1,8 @@
+# Shell - `tmuxp.shell`
+
+```{eval-rst}
+.. automodule:: tmuxp.shell
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/types.md b/docs/api/types.md
@@ -0,0 +1,8 @@
+# Typings - `tmuxp.types`
+
+```{eval-rst}
+.. automodule:: tmuxp.types
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/util.md b/docs/api/util.md
@@ -0,0 +1,8 @@
+# Utilities - `tmuxp.util`
+
+```{eval-rst}
+.. automodule:: tmuxp.util
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/workspace/builder.md b/docs/api/workspace/builder.md
@@ -0,0 +1,8 @@
+# Builder - `tmuxp.workspace.builder`
+
+```{eval-rst}
+.. automodule:: tmuxp.workspace.builder
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/workspace/constants.md b/docs/api/workspace/constants.md
@@ -0,0 +1,8 @@
+# Constants - `tmuxp.workspace.constants`
+
+```{eval-rst}
+.. automodule:: tmuxp.workspace.constants
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/workspace/finders.md b/docs/api/workspace/finders.md
@@ -0,0 +1,8 @@
+# Finders - `tmuxp.workspace.finders`
+
+```{eval-rst}
+.. automodule:: tmuxp.workspace.finders
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/workspace/freezer.md b/docs/api/workspace/freezer.md
@@ -0,0 +1,8 @@
+# Freezer - `tmuxp.workspace.freezer`
+
+```{eval-rst}
+.. automodule:: tmuxp.workspace.freezer
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```
diff --git a/docs/api/workspace/importers.md b/docs/api/workspace/importers.md
diff --git a/docs/api/workspace/index.md b/docs/api/workspace/index.md
diff --git a/docs/api/workspace/loader.md b/docs/api/workspace/loader.md
diff --git a/docs/api/workspace/validation.md b/docs/api/workspace/validation.md
