Skip to content

Commit bf5da4e

Browse files
committed
docs: Format with prettier
1 parent a462e91 commit bf5da4e

File tree

11 files changed

+46
-91
lines changed

11 files changed

+46
-91
lines changed

docs/about.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ To jump right in, see {ref}`quickstart` and {ref}`examples`.
2020
Interested in some kung-fu or joining the effort? {ref}`api` and
2121
{ref}`developing`.
2222

23-
[MIT-licensed][mit-licensed]. Code on [github](<http://github.com/tmux-python/tmuxp>).
23+
[MIT-licensed][mit-licensed]. Code on [github](http://github.com/tmux-python/tmuxp).
2424

2525
[bugsnag]: https://blog.bugsnag.com/benefits-of-using-tmux/
26-
2726
[pragmatic coders]: http://pragmaticcoders.com/blog/tmuxp-preconfigured-sessions/
2827

2928
## Differences from tmuxinator / teamocil
@@ -81,9 +80,10 @@ See {ref}`libtmux's internals <libtmux:Internals>`.
8180
**Conversion** `$ tmuxp convert <filename>` can convert files to and
8281
from JSON and YAML.
8382

84-
[^id4]: While freezing and importing sessions is a great way to save time,
85-
tweaking will probably be required - There is no substitute to a
86-
config made with love.
83+
[^id4]:
84+
While freezing and importing sessions is a great way to save time,
85+
tweaking will probably be required - There is no substitute to a
86+
config made with love.
8787

8888
[libtmux]: https://libtmux.git-pull.com
8989

@@ -103,17 +103,9 @@ from JSON and YAML.
103103
`$ tmuxp -f<config-file>` for config file.
104104

105105
[attempt at 1.7 test]: https://travis-ci.org/tmux-python/tmuxp/jobs/12348263
106-
107106
[kaptan]: https://github.com/emre/kaptan
108-
109107
[mit-licensed]: http://opensource.org/licenses/MIT
110-
111108
[tmuxinator]: https://github.com/aziz/tmuxinator
112-
113109
[teamocil]: https://github.com/remiprev/teamocil
114-
115110
[erb]: http://ruby-doc.org/stdlib-2.0.0/libdoc/erb/rdoc/ERB.html
116-
117111
[edit this page]: https://github.com/tmux-python/tmuxp/edit/master/doc/about.rst
118-
119-

docs/about_tmux.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# The Tao of tmux
44

5-
:::{figure} /_static/tao-tmux-screenshot.png
5+
:::{figure} /\_static/tao-tmux-screenshot.png
66
:scale: 60%
77
:align: center
88

@@ -47,7 +47,7 @@ Pane Application Performs operations
4747
```
4848

4949
```{eval-rst}
50-
.. aafig::
50+
.. aafig::
5151
:textual:
5252
5353
+----------------------------------------------------------------+
@@ -90,7 +90,7 @@ One screen can be used to edit a file, and another may be used to
9090
`$ tail -F` a logfile.
9191

9292
```{eval-rst}
93-
.. aafig::
93+
.. aafig::
9494
9595
+--------+--------+
9696
| $ bash | $ bash |
@@ -104,7 +104,7 @@ One screen can be used to edit a file, and another may be used to
104104
```
105105

106106
```{eval-rst}
107-
.. aafig::
107+
.. aafig::
108108
109109
+--------+--------+
110110
| $ bash | $ bash |
@@ -120,7 +120,7 @@ One screen can be used to edit a file, and another may be used to
120120
tmux supports as manys terminals as you want.
121121

122122
```{eval-rst}
123-
.. aafig::
123+
.. aafig::
124124
:textual:
125125
126126
+---------+---------+
@@ -158,7 +158,7 @@ You can leave tmux and all applications running (detach), log out, make a
158158
sandwich, and re-(attach), all applications are still running!
159159

160160
```{eval-rst}
161-
.. aafig::
161+
.. aafig::
162162
:textual:
163163
164164
+--------+--------+
@@ -241,15 +241,10 @@ If **compiling from source**, the dependencies are [libevent][libevent] and
241241
[ncurses][ncurses].
242242

243243
[tmux homepage]: http://tmux.sourceforge.net/
244-
245244
[libevent]: http://www.monkey.org/~provos/libevent/
246-
247245
[ncurses]: http://invisible-island.net/ncurses/
248-
249246
[macports]: http://www.macports.org/
250-
251247
[fink]: http://fink.thetis.ig42.org/
252-
253248
[homebrew]: http://www.brew.sh
254249

255250
## Using tmux
@@ -287,7 +282,7 @@ This could be because:
287282
Tmux hot keys have to be pressed in a special way. **Read this
288283
carefully**, then try it yourself.
289284

290-
First, you press the *prefix* key. This is `C-b` by default.
285+
First, you press the _prefix_ key. This is `C-b` by default.
291286

292287
Release. Then pause. For less than second. Then type what's next.
293288

@@ -298,15 +293,15 @@ Then press `o`.
298293

299294
### Session Name
300295

301-
Sessions can be *named upon creation*.
296+
Sessions can be _named upon creation_.
302297

303298
```{code-block} bash
304299
305300
$ tmux new-session [-s session-name]
306301
307302
```
308303

309-
Sessions can be *renamed after creation*.
304+
Sessions can be _renamed after creation_.
310305

311306
```{eval_rst}
312307
=============== =========================================================
@@ -320,15 +315,15 @@ Short cut ``Prefix`` + ``$``
320315

321316
### Window Name
322317

323-
Windows can be *named upon creation*.
318+
Windows can be _named upon creation_.
324319

325320
```{code-block} bash
326321
327322
$ tmux new-window [-n window-name]
328323
329324
```
330325

331-
Windows can be *renamed after creation*.
326+
Windows can be _renamed after creation_.
332327

333328
```{eval_rst}
334329
=============== ==========================================================
@@ -588,15 +583,14 @@ $(shell-command)
588583

589584
So if `/usr/local/bin/tmux-mem-cpu-load` outputs stats to
590585
`stdout`, then `$(tmux-mem-cpu-load)` is going to output the first
591-
line to the status line. The interval is determined by the
586+
line to the status line. The interval is determined by the
592587
`status-interval`:
593588

594589
```
595590
set -g status-interval 1
596591
```
597592

598593
[tmux-mem-cpu-load]: https://github.com/thewtex/tmux-mem-cpu-load
599-
600594
[basic-cpu-and-memory.tmux]: https://github.com/zaiste/tmuxified/blob/master/scripts/basic-cpu-and-memory.tmux
601595

602596
### Examples
@@ -714,9 +708,9 @@ $ nroff -mdoc tmux.1|less
714708

715709
::::{container} rightside-book
716710

717-
*The Tao of tmux* is available on [Leanpub][leanpub] and [Kindle][kindle] (Amazon).
711+
_The Tao of tmux_ is available on [Leanpub][leanpub] and [Kindle][kindle] (Amazon).
718712

719-
:::{figure} _static/img/books/amazon-logo.png
713+
:::{figure} \_static/img/books/amazon-logo.png
720714
:scale: 19%
721715
:target: http://amzn.to/2gPfRhC
722716
:alt: Amazon Kindle
@@ -728,15 +722,11 @@ Read and browse the book for [free on the web][free on the web].
728722
::::
729723

730724
[free on the web]: https://leanpub.com/the-tao-of-tmux/read
731-
732725
[leanpub]: https://leanpub.com/the-tao-of-tmux
733-
734726
[kindle]: http://amzn.to/2gPfRhC
735727

736728
:::::::
737729

738730
### License
739731

740732
This page is licensed [Creative Commons BY-NC-ND 3.0 US][creative commons by-nc-nd 3.0 us].
741-
742-

docs/api.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44

55
:::{seealso}
66

7-
See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart
8-
<libtmux:quickstart>` to see how you can control tmux via python API calls.
7+
See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>` to see how you can control tmux via python API calls.
98

109
:::
1110

@@ -143,5 +142,3 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart
143142
```{eval-rst}
144143
.. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
145144
```
146-
147-

docs/cli.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,16 @@ tmuxp shell -c 'python code'
4141
Launch into a python console with [libtmux][libtmux] objects. Compare to django's shell.
4242

4343
> > ```{image} _static/tmuxp-shell.gif
44-
> :width: 100%
45-
>
44+
> > :width: 100%
45+
> > ```
46+
>
47+
> ```
48+
>
49+
> Automatically preloads current tmux {class}`server <libtmux.Server>`,
50+
> {class}`session <libtmux.Session>`, {class}`window <libtmux.Window>`
51+
> {class}`pane <libtmux.Pane>`. Pass additional arguments to select a
52+
> specific one of your choice:
4653
> ```
47-
>
48-
Automatically preloads current tmux {class}`server <libtmux.Server>`,
49-
{class}`session <libtmux.Session>`, {class}`window <libtmux.Window>`
50-
{class}`pane <libtmux.Pane>`. Pass additional arguments to select a
51-
specific one of your choice:
5254
5355
```
5456
(Pdb) server
@@ -107,14 +109,12 @@ my_window
107109
```
108110

109111
[pep 553]: https://www.python.org/dev/peps/pep-0553/
110-
111112
[ipdb]: https://pypi.org/project/ipdb/
112-
113113
[libtmux]: https://libtmux.git-pull.com
114114

115115
### Shell detection
116116

117-
`tmuxp shell` detects the richest shell available in your *site packages*, you can also pick your shell via args:
117+
`tmuxp shell` detects the richest shell available in your _site packages_, you can also pick your shell via args:
118118

119119
- `--pdb`: Use plain old `breakpoint()` (python 3.7+) or
120120
`pdb.set_trace`
@@ -274,6 +274,4 @@ tmuxp convert /path/to/file.{json,yaml}
274274
```
275275

276276
tmuxp automatically will prompt to convert `.yaml` to `.json` and
277-
`.json` to `.yaml`.
278-
279-
277+
`.json` to `.yaml`.

docs/developing.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Developing and Testing
44

55
```{eval-rst}
6-
.. todo::
6+
.. todo::
77
link to sliderepl or ipython notebook slides
88
```
99

@@ -113,7 +113,6 @@ $ poetry shell
113113
That is it! You are now ready to code!
114114

115115
[poetry]: https://python-poetry.org/
116-
117116
[poetry's documentation]: https://python-poetry.org/docs/
118117

119118
## Test Runner
@@ -174,10 +173,11 @@ open in a separate terminal.
174173
Create two terminals:
175174

176175
> > - Terminal 1: `$ tmux -L test_case`
176+
>
177177
> - Terminal 2: `$ cd` into the tmuxp project and into the
178178
> `virtualenv` if you are using one, see details on installing the dev
179179
> version of tmuxp above. Then:
180-
>
180+
>
181181
> ```
182182
> $ py.test tests/test_workspacebuilder.py
183183
> ```
@@ -195,7 +195,7 @@ This requires `entr(1)`.
195195
196196
:::
197197
198-
Install [entr][entr]. Packages are available available on most Linux and BSD
198+
Install [entr][entr]. Packages are available available on most Linux and BSD
199199
variants, including Debian, Ubuntu, FreeBSD, OS X.
200200
201201
To run all tests upon editing any `.py` file:
@@ -279,15 +279,8 @@ e.g. `RETRY_TIMEOUT_SECONDS=10 py.test`
279279
```
280280

281281
[py.test usage argument]: https://pytest.org/latest/usage.html
282-
283282
[entr]: http://entrproject.org/
284-
285283
[github actions]: https://github.com/features/actions
286-
287284
[gh build site]: https://github.com/tmux-python/tmuxp/actions?query=workflow%3Atests
288-
289285
[.github/workflows/tests.yml]: https://github.com/tmux-python/tmuxp/blob/master/.github/workflows/tests.yml
290-
291286
[issue on github]: https://github.com/tmux-python/tmuxp/issues
292-
293-

docs/examples.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ punctual.
1010
::::{sidebar} short hand
1111

1212
```{eval-rst}
13-
.. aafig::
13+
.. aafig::
1414
:textual:
1515
1616
+-------------------+
@@ -67,7 +67,7 @@ Note `''` counts as an empty carriage return.
6767
::::{sidebar} 2 pane
6868

6969
```{eval-rst}
70-
.. aafig::
70+
.. aafig::
7171
7272
+-----------------+
7373
| $ pwd |
@@ -101,7 +101,7 @@ Note `''` counts as an empty carriage return.
101101
::::{sidebar} 3 panes
102102

103103
```{eval-rst}
104-
.. aafig::
104+
.. aafig::
105105
106106
+-----------------+
107107
| $ pwd |
@@ -135,7 +135,7 @@ Note `''` counts as an empty carriage return.
135135
::::{sidebar} 4 panes
136136

137137
```{eval-rst}
138-
.. aafig::
138+
.. aafig::
139139
140140
+--------+--------+
141141
| $ pwd | $ pwd |
@@ -402,7 +402,7 @@ A successful script will exit with a status of `0`.
402402
Important: the script file must be chmod executable `+x` or `755`.
403403

404404
Run a python script (and check for it's return code), the script is
405-
*relative to the ``.tmuxp.yaml``'s root* (Windows and panes omitted in
405+
_relative to the `.tmuxp.yaml`'s root_ (Windows and panes omitted in
406406
this example):
407407

408408
```{code-block} yaml
@@ -461,9 +461,9 @@ $ tmuxp load ~/workspaces/myproject.yaml
461461
See examples of `tmuxp` in the wild. Have a project config to show off?
462462
Edit this page.
463463

464-
* <https://github.com/tony/dockerfiles/blob/master/.tmuxp.yaml>
465-
* <https://github.com/tony/vcspull/blob/master/.tmuxp.yaml>
466-
* <https://github.com/tony/sphinxcontrib-github/blob/master/.tmuxp.yaml>
464+
- <https://github.com/tony/dockerfiles/blob/master/.tmuxp.yaml>
465+
- <https://github.com/tony/vcspull/blob/master/.tmuxp.yaml>
466+
- <https://github.com/tony/sphinxcontrib-github/blob/master/.tmuxp.yaml>
467467

468468
You can use `start_directory: ./` to make the directories relative to
469469
the config file / project root.
@@ -516,7 +516,6 @@ windows:
516516
```
517517

518518
[pipenv]: https://docs.pipenv.org/
519-
520519
[poetry]: https://python-poetry.org/
521520

522521
## Kung fu
@@ -533,5 +532,3 @@ See: {meth}`tmuxp.config.validate_schema`.
533532
Add yours? Submit a pull request to the [github][github] site!
534533

535534
[github]: https://github.com/tmux-python/tmuxp
536-
537-

0 commit comments

Comments
 (0)