Skip to content

Commit e7a191f

Browse files
committed
docs: Misc. link fixes
1 parent 3d31f34 commit e7a191f

File tree

5 files changed

+29
-33
lines changed

5 files changed

+29
-33
lines changed

CHANGES

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
windows:
1414
- panes:
1515
- shell_command:
16-
- cmd: echo "___$((1 + 3))___"
17-
enter: false
18-
19-
# pane-wide skip
16+
- echo "this sends"
17+
- cmd: echo "___$((1 + 3))___"
18+
enter: false
19+
# pane-wide skip
2020
- shell_command:
21-
- echo "___$((1 + 3))___"
21+
- echo "___$((1 + 3))___"
2222
enter: false
2323
```
2424
@@ -27,20 +27,20 @@
2727
```yaml
2828
session_name: Pause / skip command execution (command-level)
2929
windows:
30-
- panes:
31-
- shell_command:
32-
# Executes immediately
33-
- echo "___$((11 + 1))___"
34-
# Delays before sending 2 seconds
35-
- cmd: echo "___$((1 + 3))___"
36-
sleep_before: 2
37-
# Executes immediately
38-
- cmd: echo "___$((1 + 3))___"
39-
# Pauses 2 seconds after
40-
- cmd: echo "Stuff rendering here!"
41-
sleep_after: 2
42-
# Executes after earlier commands (after 2 sec)
43-
- cmd: echo "2 seconds later"
30+
- panes:
31+
- shell_command:
32+
# Executes immediately
33+
- echo "___$((11 + 1))___"
34+
# Delays before sending 2 seconds
35+
- cmd: echo "___$((1 + 3))___"
36+
sleep_before: 2
37+
# Executes immediately
38+
- cmd: echo "___$((1 + 3))___"
39+
# Pauses 2 seconds after
40+
- cmd: echo "Stuff rendering here!"
41+
sleep_after: 2
42+
# Executes after earlier commands (after 2 sec)
43+
- cmd: echo "2 seconds later"
4444
```
4545

4646
- #701: `tmuxp freeze` now accepts `--quiet` and `--yes` along with the
@@ -347,7 +347,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
347347
348348
```
349349

350-
As of {ref}`1.6.1 (above) <v1.6.1>`, `tmuxp shell` will find the most
350+
As of {ref}`1.6.1 (above) <v1-6-1>`, `tmuxp shell` will find the most
351351
feature-rich shell available. If you have [ipython][ipython], [ptpython][ptpython], or
352352
[bpython][bpython] available, it will be selected automatically. Pass `--pdb`
353353
to use standard library pdb, or `--code` to use `code.interact`.
@@ -925,12 +925,12 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
925925
- {issue}`19` accept `-y` argument to answer yes to questions.
926926
- {meth}`cli.SessionCompleter` no longer allows a duplicate session
927927
after one is added.
928-
- ongoing work on {ref}`about_tmux`.
928+
- ongoing work on {ref}`about-tmux`.
929929

930930
## tmuxp 0.1-dev (2013-11-09)
931931

932932
- [translation] [documentation in Chinese][documentation in chinese] from [wrongwaycn][wrongwaycn].
933-
- More work done on the {ref}`about_tmux` page.
933+
- More work done on the {ref}`about-tmux` page.
934934
- {meth}`Pane.split_window()` for splitting {class}`Window` at
935935
`target-pane` location.
936936

@@ -978,7 +978,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
978978
- Support for `[-L socket-name]` and `[-S socket-path]` in
979979
autocompletion and when loading. Note, switching client into another
980980
socket may cause an error.
981-
- Documentation tweaking to {ref}`API`, {ref}`about_tmux`.
981+
- Documentation tweaking to {ref}`API`, {ref}`about-tmux`.
982982
- [pep257][pep257], [pep8][pep8].
983983

984984
## tmuxp 0.1-dev (2013-11-04)
@@ -1190,7 +1190,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
11901190
install because missing file
11911191
- bash / zsh completion.
11921192
- New page on {ref}`internals`.
1193-
- Updates to {ref}`about_tmux` page.
1193+
- Updates to {ref}`about-tmux` page.
11941194
- add vim modeline for rst to bottom of this page
11951195
- Server is now a subclass of `util.TmuxObject`.
11961196
- subclasses of {class}`util.TmuxRelationalObject`,

docs/about.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ directly shell commands. tmuxp processes configuration via ORM layer.
6464
support. See {ref}`commands`.
6565

6666
**Import config** import configs from Teamocil / Tmuxinator [^id4]. See
67-
{ref}`cli_import`.
67+
{ref}`cli-import`.
6868

6969
**Session freezing** Supports session freezing into YAML and JSON
70-
format [^id4]. See {ref}`cli_freeze`.
70+
format [^id4]. See {ref}`cli-freeze`.
7171

7272
**JSON config** JSON config support. See {ref}`Examples`.
7373

@@ -91,7 +91,7 @@ from JSON and YAML.
9191
## Minor tweaks
9292

9393
- Unit tests against live tmux version to test statefulness of tmux
94-
sessions, windows and panes. See {ref}`travis`.
94+
sessions, windows and panes. See {ref}`gh-actions`.
9595
- Load + switch to new session from inside tmux.
9696
- Resume session if config loaded.
9797
- Pre-commands virtualenv / rvm / any other commands.

docs/api.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>
77
tmux via python API calls.
88
:::
99

10-
```{module} tmuxp
11-
12-
```
13-
1410
## Internals
1511

1612
:::{warning}

docs/developing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ $ make SPHINXBUILD='poetry run sphinx-build' watch
240240
241241
```
242242

243-
After you {ref}`install_dev_env`, when inside the tmuxp checkout:
243+
After you {ref}`install-dev-env`, when inside the tmuxp checkout:
244244

245245
```console
246246

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
:start-after: "# Freeze a tmux session"
2020
```
2121

22-
### Table of Contents
22+
## Table of Contents
2323

2424
```{toctree}
2525
:maxdepth: 2

0 commit comments

Comments
 (0)