Skip to content

Commit 2dc64ef

Browse files
committed
docs(readme): update links to clean URLs for dirhtml builder
why: Switched to dirhtml builder which generates clean URLs (/quickstart/ instead of /quickstart.html). README links need to match since they render on GitHub/PyPI where redirects don't apply. what: - Convert all .html doc links to trailing-slash format - Covers: topics/, api/, pytest-plugin/, history, migration, quickstart
1 parent 2a6fdae commit 2dc64ef

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ libtmux is a typed Python API over [tmux], the terminal multiplexer. Stop shelli
2020
### ✨ Features
2121

2222
- Typed, object-oriented control of tmux state
23-
- Query and [traverse](https://libtmux.git-pull.com/topics/traversal.html) live sessions, windows, and panes
23+
- Query and [traverse](https://libtmux.git-pull.com/topics/traversal/) live sessions, windows, and panes
2424
- Raw escape hatch via `.cmd(...)` on any object
2525
- Works with multiple tmux sockets and servers
26-
- [Context managers](https://libtmux.git-pull.com/topics/context_managers.html) for automatic cleanup
27-
- [pytest plugin](https://libtmux.git-pull.com/pytest-plugin/index.html) for isolated tmux fixtures
26+
- [Context managers](https://libtmux.git-pull.com/topics/context_managers/) for automatic cleanup
27+
- [pytest plugin](https://libtmux.git-pull.com/api/pytest-plugin/) for isolated tmux fixtures
2828
- Proven in production via tmuxp and other tooling
2929

3030
## Requirements & support
@@ -117,7 +117,7 @@ current tmux server / session / window / pane.
117117

118118
[ptpython]: https://github.com/prompt-toolkit/ptpython
119119
[ipython]: https://ipython.org/
120-
[`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell.html
120+
[`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell/
121121

122122
### Run any tmux command
123123

@@ -138,7 +138,7 @@ Create a new session:
138138

139139
### List and filter sessions
140140

141-
[**Learn more about Filtering**](https://libtmux.git-pull.com/topics/filtering.html)
141+
[**Learn more about Filtering**](https://libtmux.git-pull.com/topics/filtering/)
142142

143143
```python
144144
>>> server.sessions
@@ -161,7 +161,7 @@ Session($... ...)
161161

162162
### Control sessions and windows
163163

164-
[**Learn more about Workspace Setup**](https://libtmux.git-pull.com/topics/workspace_setup.html)
164+
[**Learn more about Workspace Setup**](https://libtmux.git-pull.com/topics/workspace_setup/)
165165

166166
```python
167167
>>> session.rename_session('my-session')
@@ -186,7 +186,7 @@ Window(@... ...:bg-work, Session($... ...))
186186

187187
### Split windows and send keys
188188

189-
[**Learn more about Pane Interaction**](https://libtmux.git-pull.com/topics/pane_interaction.html)
189+
[**Learn more about Pane Interaction**](https://libtmux.git-pull.com/topics/pane_interaction/)
190190

191191
```python
192192
>>> pane = window.split(attach=False)
@@ -215,7 +215,7 @@ Pane(%... ...)
215215

216216
### Traverse the hierarchy
217217

218-
[**Learn more about Traversal**](https://libtmux.git-pull.com/topics/traversal.html)
218+
[**Learn more about Traversal**](https://libtmux.git-pull.com/topics/traversal/)
219219

220220
Navigate from pane up to window to session:
221221

@@ -230,12 +230,12 @@ Session($... ...)
230230

231231
| libtmux object | tmux concept | Notes |
232232
|----------------|-----------------------------|--------------------------------|
233-
| [`Server`](https://libtmux.git-pull.com/api/libtmux.server.html) | tmux server / socket | Entry point; owns sessions |
234-
| [`Session`](https://libtmux.git-pull.com/api/libtmux.session.html) | tmux session (`$0`, `$1`,...) | Owns windows |
235-
| [`Window`](https://libtmux.git-pull.com/api/libtmux.window.html) | tmux window (`@1`, `@2`,...) | Owns panes |
236-
| [`Pane`](https://libtmux.git-pull.com/api/libtmux.pane.html) | tmux pane (`%1`, `%2`,...) | Where commands run |
233+
| [`Server`](https://libtmux.git-pull.com/api/libtmux.server/) | tmux server / socket | Entry point; owns sessions |
234+
| [`Session`](https://libtmux.git-pull.com/api/libtmux.session/) | tmux session (`$0`, `$1`,...) | Owns windows |
235+
| [`Window`](https://libtmux.git-pull.com/api/libtmux.window/) | tmux window (`@1`, `@2`,...) | Owns panes |
236+
| [`Pane`](https://libtmux.git-pull.com/api/libtmux.pane/) | tmux pane (`%1`, `%2`,...) | Where commands run |
237237

238-
Also available: [`Options`](https://libtmux.git-pull.com/api/libtmux.options.html) and [`Hooks`](https://libtmux.git-pull.com/api/libtmux.hooks.html) abstractions for tmux configuration.
238+
Also available: [`Options`](https://libtmux.git-pull.com/api/libtmux.options/) and [`Hooks`](https://libtmux.git-pull.com/api/libtmux.hooks/) abstractions for tmux configuration.
239239

240240
Collections are live and queryable:
241241

@@ -257,7 +257,7 @@ pane.send_keys("echo 'hello from libtmux'", enter=True)
257257

258258
## Testing & fixtures
259259

260-
[**Learn more about the pytest plugin**](https://libtmux.git-pull.com/pytest-plugin/index.html)
260+
[**Learn more about the pytest plugin**](https://libtmux.git-pull.com/api/pytest-plugin/)
261261

262262
Writing a tool that interacts with tmux? Use our fixtures to keep your tests clean and isolated.
263263

@@ -285,18 +285,18 @@ def test_my_tmux_tool(session):
285285
## Project links
286286

287287
**Topics:**
288-
[Traversal](https://libtmux.git-pull.com/topics/traversal.html) ·
289-
[Filtering](https://libtmux.git-pull.com/topics/filtering.html) ·
290-
[Pane Interaction](https://libtmux.git-pull.com/topics/pane_interaction.html) ·
291-
[Workspace Setup](https://libtmux.git-pull.com/topics/workspace_setup.html) ·
292-
[Automation Patterns](https://libtmux.git-pull.com/topics/automation_patterns.html) ·
293-
[Context Managers](https://libtmux.git-pull.com/topics/context_managers.html) ·
294-
[Options & Hooks](https://libtmux.git-pull.com/topics/options_and_hooks.html)
288+
[Traversal](https://libtmux.git-pull.com/topics/traversal/) ·
289+
[Filtering](https://libtmux.git-pull.com/topics/filtering/) ·
290+
[Pane Interaction](https://libtmux.git-pull.com/topics/pane_interaction/) ·
291+
[Workspace Setup](https://libtmux.git-pull.com/topics/workspace_setup/) ·
292+
[Automation Patterns](https://libtmux.git-pull.com/topics/automation_patterns/) ·
293+
[Context Managers](https://libtmux.git-pull.com/topics/context_managers/) ·
294+
[Options & Hooks](https://libtmux.git-pull.com/topics/options_and_hooks/)
295295

296296
**Reference:**
297297
[Docs][docs] ·
298298
[API][api] ·
299-
[pytest plugin](https://libtmux.git-pull.com/pytest-plugin/index.html) ·
299+
[pytest plugin](https://libtmux.git-pull.com/api/pytest-plugin/) ·
300300
[Architecture][architecture] ·
301301
[Changelog][history] ·
302302
[Migration][migration]
@@ -315,10 +315,10 @@ def test_my_tmux_tool(session):
315315
Contributions are welcome. Please open an issue or PR if you find a bug or want to improve the API or docs. If libtmux helps you ship, consider sponsoring development via [support].
316316

317317
[docs]: https://libtmux.git-pull.com
318-
[api]: https://libtmux.git-pull.com/api.html
319-
[architecture]: https://libtmux.git-pull.com/about.html
320-
[history]: https://libtmux.git-pull.com/history.html
321-
[migration]: https://libtmux.git-pull.com/migration.html
318+
[api]: https://libtmux.git-pull.com/api/
319+
[architecture]: https://libtmux.git-pull.com/topics/architecture/
320+
[history]: https://libtmux.git-pull.com/history/
321+
[migration]: https://libtmux.git-pull.com/migration/
322322
[issues]: https://github.com/tmux-python/libtmux/issues
323323
[coverage]: https://codecov.io/gh/tmux-python/libtmux
324324
[releases]: https://pypi.org/project/libtmux/

0 commit comments

Comments
 (0)