Skip to content

Commit 49d9e9b

Browse files
committed
docs: Add :no-index: to module directives to fix duplicate warnings
why: Sphinx warns about duplicate object descriptions when the same module is referenced in multiple documentation files. what: - Add :no-index: directive to module blocks in windows.md, pytest-plugin/index.md, and quickstart.md to prevent duplicate indexing
1 parent 0828fbd commit 49d9e9b

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/api/windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Identified by `@`, e.g. `@313`
88

99
```{module} libtmux
10-
10+
:no-index:
1111
```
1212

1313
```{eval-rst}

docs/pytest-plugin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ your case, we won't stabilize APIs until we're sure everything is by the book.
1313
[connect with us]: https://github.com/tmux-python/libtmux/discussions
1414
1515
```{module} libtmux.pytest_plugin
16-
16+
:no-index:
1717
```
1818

1919
## Usage

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ $ ptpython
129129
```
130130

131131
```{module} libtmux
132-
132+
:no-index:
133133
```
134134

135135
First, we can grab a {class}`Server`.

0 commit comments

Comments
 (0)