Docs: Split API to multiple pages (#898)

Resolves #895

Author: tony

CHANGES

@@ -27,6 +27,11 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 - `config_reader`: Move to `tmuxp._internal` (#897)
 - `_types`: Move to `tmuxp._internal` (#900)
 
+### Documentation
+
+- Refactor API docs to split across multiple pages (#898)
+- Remove unused reStructuredText section headers from some modules (#898)
+
 ## tmuxp 1.33.0 (2023-12-21)
 
 _Maintenance only, no bug fixes or new features_

docs/_ext/aafig.py

@@ -1,6 +1,6 @@
 """aafig plugin for sphinx.
 
-sphinxcontrib.aafig.
+sphinxcontrib.aafig
 ~~~~~~~~~~~~~~~~~~~
 
 Allow embedded ASCII art to be rendered as nice looking images

docs/api.md

@@ -0,0 +1,8 @@
+# tmuxp convert - `tmuxp.cli.convert`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.convert
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/convert.md

@@ -0,0 +1,8 @@
+# tmuxp debug-info - `tmuxp.cli.debug_info`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.debug_info
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/debug_info.md

@@ -0,0 +1,8 @@
+# tmuxp edit - `tmuxp.cli.edit`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.edit
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/edit.md

@@ -0,0 +1,8 @@
+# tmuxp freeze - `tmuxp.cli.freeze`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.freeze
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/freeze.md

@@ -0,0 +1,8 @@
+# tmuxp import - `tmuxp.cli.import_config`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.import_config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/import_config.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:
+```

docs/api/cli/index.md

@@ -0,0 +1,8 @@
+# tmuxp load - `tmuxp.cli.load`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.load
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/load.md

@@ -0,0 +1,8 @@
+# tmuxp ls - `tmuxp.cli.ls`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.ls
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/ls.md

@@ -0,0 +1,8 @@
+# tmuxp shell - `tmuxp.cli.shell`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.shell
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/shell.md

@@ -0,0 +1,8 @@
+# CLI utilities - `tmuxp.cli.utils`
+
+```{eval-rst}
+.. automodule:: tmuxp.cli.utils
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/cli/utils.md

@@ -0,0 +1,8 @@
+# Exceptions - `tmuxp.exc`
+
+```{eval-rst}
+.. automodule:: tmuxp.exc
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/exc.md

@@ -0,0 +1,20 @@
+(api)=
+
+# API Reference
+
+:::{seealso}
+See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>` to see how you can control
+tmux via python API calls.
+:::
+
+```{toctree}
+internals/index
+cli/index
+workspace/index
+exc
+log
+plugin
+shell
+util
+types
+```

docs/api/index.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:
+```

docs/api/internals/config_reader.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
+```

docs/api/internals/index.md

@@ -0,0 +1,8 @@
+# Typings - `tmuxp._internal.types`
+
+```{eval-rst}
+.. automodule:: tmuxp._internal.types
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/internals/types.md

@@ -0,0 +1,8 @@
+# Logging - `tmuxp.log`
+
+```{eval-rst}
+.. automodule:: tmuxp.log
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/log.md

@@ -0,0 +1,8 @@
+# Plugin - `tmuxp.plugin`
+
+```{eval-rst}
+.. automodule:: tmuxp.plugin
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/plugin.md

@@ -0,0 +1,8 @@
+# Shell - `tmuxp.shell`
+
+```{eval-rst}
+.. automodule:: tmuxp.shell
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/shell.md

@@ -0,0 +1,8 @@
+# Typings - `tmuxp.types`
+
+```{eval-rst}
+.. automodule:: tmuxp.types
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/api/types.md

@@ -0,0 +1,8 @@
+# Utilities - `tmuxp.util`
+
+```{eval-rst}
+.. automodule:: tmuxp.util
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```