Skip to content

Commit 1f1aeba

Browse files
committed
docs: Organize pytest-plugin
1 parent 3df7209 commit 1f1aeba

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/pytest-plugin/index.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@
55
libtmux provides pytest fixtures for tmux. The plugin automatically manages setup and teardown of an
66
independent tmux server.
77

8-
```{toctree}
9-
10-
test
11-
```
12-
138
```{seealso} Using the pytest plugin?
149
1510
Do you want more flexbility? Correctness? Power? Defaults changed? [Connect with us] on the tracker, we want to know
@@ -33,7 +28,15 @@ $ pip install libtmux
3328

3429
The pytest plugin will be automatically detected via pytest, and the fixtures will be added.
3530

36-
## Fixtures
31+
### Real world usage
32+
33+
View libtmux's own [tests/](https://github.com/tmux-python/libtmux/tree/master/tests) as well as
34+
tmuxp's [tests/](https://github.com/tmux-python/tmuxp/tree/master/tests).
35+
36+
libtmux's tests `autouse` the {ref}`recommended-fixtures` above to ensure stable, assertions and
37+
object lookups in the test grid.
38+
39+
## pytest-tmux
3740

3841
`pytest-tmux` works through providing {ref}`pytest fixtures <pytest:fixtures-api>` - so read up on
3942
those!
@@ -82,15 +85,7 @@ def set_home(
8285
monkeypatch.setenv("HOME", str(user_path))
8386
```
8487

85-
## See examples
86-
87-
View libtmux's own [tests/](https://github.com/tmux-python/libtmux/tree/master/tests) as well as
88-
tmuxp's [tests/](https://github.com/tmux-python/tmuxp/tree/master/tests).
89-
90-
libtmux's tests `autouse` the {ref}`recommended-fixtures` above to ensure stable, assertions and
91-
object lookups in the test grid.
92-
93-
## API reference
88+
## Fixtures
9489

9590
```{eval-rst}
9691
.. automodule:: libtmux.pytest_plugin
@@ -100,3 +95,11 @@ object lookups in the test grid.
10095
:show-inheritance:
10196
:member-order: bysource
10297
```
98+
99+
## Test utilities
100+
101+
```{toctree}
102+
:maxdepth: 1
103+
104+
test
105+
```

0 commit comments

Comments
 (0)