Skip to content

Commit 9e278da

Browse files
committed
docs(testing[nav]): promote testing/ to first-class nav; drop empty libtmux.test page
why: api/testing/ was buried two levels deep (homepage → API Reference → Testing card). The pytest plugin is a major feature that deserves direct homepage visibility. Separately, libtmux.test.md generated an empty page because test/__init__.py has only a docstring — all actual API is already documented on the 5 submodule leaf pages. what: - Add Testing card to docs/index.md homepage grid (grid 1 1 2 2 → 1 1 3 3) - Add api/testing/index to root toctree so Testing appears in sidebar alongside API Reference, Topics, Project - Remove docs/api/testing/test-helpers/libtmux.test.md (empty automodule) - Remove libtmux.test card and toctree entry from test-helpers/index.md - Add redirect api/testing/test-helpers/libtmux.test → test-helpers/index
1 parent 1645225 commit 9e278da

4 files changed

Lines changed: 10 additions & 20 deletions

File tree

docs/api/testing/test-helpers/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ Utilities for writing reliable tests against libtmux and downstream code that us
77
::::{grid} 1 2 3 3
88
:gutter: 2 2 3 3
99

10-
:::{grid-item-card} libtmux.test
11-
:link: libtmux.test
12-
:link-type: doc
13-
Base test module with common setup utilities.
14-
:::
1510
:::{grid-item-card} Constants
1611
:link: constants
1712
:link-type: doc
@@ -44,7 +39,6 @@ Context managers for ephemeral tmux resources.
4439
:hidden:
4540
:maxdepth: 1
4641
47-
libtmux.test
4842
constants
4943
environment
5044
random

docs/api/testing/test-helpers/libtmux.test.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Typed Python API for [tmux](https://github.com/tmux/tmux). Control
66
servers, sessions, windows, and panes as Python objects.
77

8-
::::{grid} 1 1 2 2
8+
::::{grid} 1 1 3 3
99
:gutter: 2 2 3 3
1010

1111
:::{grid-item-card} Quickstart
@@ -26,6 +26,12 @@ Architecture, traversal, filtering, and automation patterns.
2626
Every public class, function, and exception.
2727
:::
2828

29+
:::{grid-item-card} Testing
30+
:link: api/testing/index
31+
:link-type: doc
32+
pytest plugin and test helpers for isolated tmux environments.
33+
:::
34+
2935
:::{grid-item-card} Contributing
3036
:link: project/index
3137
:link-type: doc
@@ -93,6 +99,7 @@ def test_my_tool(session):
9399
quickstart
94100
topics/index
95101
api/index
102+
api/testing/index
96103
internals/index
97104
project/index
98105
history

docs/redirects.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,5 @@
5353
"api/public-api.md" "project/public-api.md"
5454
"api/compatibility.md" "project/compatibility.md"
5555
"api/deprecations.md" "project/deprecations.md"
56+
# libtmux.test package page removed — empty __init__.py, no members to document
57+
"api/testing/test-helpers/libtmux.test.md" "api/testing/test-helpers/index.md"

0 commit comments

Comments
 (0)