Skip to content

Commit c6c3211

Browse files
committed
docs: Fix duplicate label, undefined ref, and strikethrough warnings
why: Sphinx warns about duplicate labels, undefined references, and strikethrough syntax not supported in non-HTML output. what: - Remove duplicate (internals)= label from about.md - Add (setting_a_tmux_configuration)= label and fix reference in pytest-plugin/index.md - Replace ~~strikethrough~~ with italicized note in CHANGES
1 parent d55b65b commit c6c3211

File tree

3 files changed

+5
-9
lines changed

3 files changed

+5
-9
lines changed

CHANGES

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1581,10 +1581,8 @@ _Maintenance only, no bug fixes or new features_
15811581

15821582
- Python 3.7 and 3.8 returns in 0.12.0
15831583

1584-
~~Final python 3.7 and 3.8 release~~
1585-
1586-
~~Fixes and security updates will go to
1587-
[`v0.11.x`](https://github.com/tmux-python/libtmux/tree/v0.11.x)~~
1584+
*Note: This was not the final Python 3.7 and 3.8 release as originally stated.
1585+
Python 3.7 and 3.8 support was extended in 0.12.0.*
15881586

15891587
- Internal: Use new separator to split `tmux(1)` formatting information (#289,
15901588
#343)

docs/about.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
(internals)=
2-
31
(about)=
42

53
# About

docs/pytest-plugin/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ your case, we won't stabilize APIs until we're sure everything is by the book.
1212
1313
[connect with us]: https://github.com/tmux-python/libtmux/discussions
1414
15-
```
16-
1715
```{module} libtmux.pytest_plugin
1816
:no-index:
1917
```
@@ -59,6 +57,8 @@ These fixtures are automatically used when the plugin is enabled and `pytest` is
5957

6058
These are set to ensure panes and windows can be reliably referenced and asserted.
6159

60+
(setting_a_tmux_configuration)=
61+
6262
## Setting a tmux configuration
6363

6464
If you would like {func}`session fixture <libtmux.pytest_plugin.session>` to automatically use a configuration, you have a few
@@ -108,7 +108,7 @@ def test_something(TestServer):
108108
assert server.is_alive()
109109
```
110110

111-
You can also use it with custom configurations, similar to the {ref}`server fixture <Setting a tmux configuration>`:
111+
You can also use it with custom configurations, similar to the {ref}`server fixture <setting_a_tmux_configuration>`:
112112

113113
```python
114114
def test_with_config(TestServer, tmp_path):

0 commit comments

Comments
 (0)