Skip to content

Commit be7f330

Browse files
committed
docs: Fix duplicate object description warnings
why: Sphinx was warning about duplicate object descriptions what: - Add :no-index: to module directives in windows.md, pytest-plugin/index.md, and quickstart.md to prevent duplicate indexing - Remove redundant Attributes section from Pane class docstring (window property is already documented by autodoc)
1 parent 7074d6a commit be7f330

File tree

4 files changed

+3
-7
lines changed

4 files changed

+3
-7
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
@@ -15,7 +15,7 @@ your case, we won't stabilize APIs until we're sure everything is by the book.
1515
```
1616

1717
```{module} libtmux.pytest_plugin
18-
18+
:no-index:
1919
```
2020

2121
## 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`.

src/libtmux/pane.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,6 @@ class Pane(
5656
``Pane`` instances can send commands directly to a pane, or traverse
5757
between linked tmux objects.
5858
59-
Attributes
60-
----------
61-
window : :class:`Window`
62-
6359
Examples
6460
--------
6561
>>> pane

0 commit comments

Comments
 (0)