docs: Refactor for test helpers and #578

Author: tony

docs/index.md

@@ -20,6 +20,7 @@ about
 topics/index
 api/index
 pytest-plugin/index
+test-helpers/index
 ```
 
 ```{toctree}

docs/pytest-plugin/index.md

@@ -147,11 +147,3 @@ def set_home(
     :show-inheritance:
     :member-order: bysource
 ```
-
-## Test utilities
-
-```{toctree}
-:maxdepth: 1
-
-test
-```

docs/pytest-plugin/test.md

@@ -0,0 +1,10 @@
+# Constants
+
+Test-related constants used across libtmux test helpers.
+
+```{eval-rst}
+.. automodule:: libtmux.test.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+``` 

docs/test-helpers/constants.md

@@ -0,0 +1,10 @@
+# Environment
+
+Environment variable mocking utilities for tests.
+
+```{eval-rst}
+.. automodule:: libtmux.test.environment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+``` 

docs/test-helpers/environment.md

@@ -0,0 +1,17 @@
+# Test helpers
+
+Test helpers for libtmux and downstream libraries.
+
+```{toctree}
+:maxdepth: 2
+
+constants
+environment
+random
+temporary
+```
+
+```{eval-rst}
+.. automodule:: libtmux.test
+   :members:
+``` 

docs/test-helpers/index.md

@@ -0,0 +1,10 @@
+# Random
+
+Random string generation utilities for test names.
+
+```{eval-rst}
+.. automodule:: libtmux.test.random
+   :members:
+   :undoc-members:
+   :show-inheritance:
+``` 

docs/test-helpers/random.md

@@ -0,0 +1,10 @@
+# Temporary Objects
+
+Context managers for temporary tmux objects (sessions, windows).
+
+```{eval-rst}
+.. automodule:: libtmux.test.temporary
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```