Skip to content

Commit 07723aa

Browse files
committed
glamorous doc updates
1 parent b5e6b98 commit 07723aa

File tree

3 files changed

+52
-35
lines changed

3 files changed

+52
-35
lines changed

doc/developing.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,10 @@ To run test where :ref:`test_builder_visually` you may:
186186
.. _watching_testrunner: https://pypi.python.org/pypi/watching_testrunner/1.0
187187
.. _pypi: https://pypi.python.org/pypi
188188

189-
Super power
190-
"""""""""""
189+
.. _tmuxp developer config:
190+
191+
tmuxp developer config
192+
""""""""""""""""""""""
191193

192194
.. image:: _static/tmuxp-dev-screenshot.png
193195
:scale: 100%

doc/examples.rst

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ Examples
77
2 split panes
88
-------------
99

10-
.. aafig::
11-
12-
+--------+--------+
13-
| $ pwd |
14-
| |
15-
| |
16-
+-----------------+
17-
| $ pwd |
18-
| |
19-
| |
20-
+-----------------+
10+
.. sidebar:: 2 pane
11+
12+
.. aafig::
13+
14+
+-----------------+
15+
| $ pwd |
16+
| |
17+
| |
18+
+-----------------+
19+
| $ pwd |
20+
| |
21+
| |
22+
+-----------------+
2123

2224
YAML - Short form:
2325

@@ -32,40 +34,52 @@ YAML - Christmas Tree:
3234
3 panes
3335
-------
3436

35-
.. aafig::
37+
.. sidebar:: 3 panes
3638

37-
+--------+--------+
38-
| $ pwd | $ pwd |
39-
| | |
40-
| | |
41-
+--------+--------+
42-
| $ pwd | $ pwd |
43-
| | |
44-
| | |
45-
+--------+--------+
39+
.. aafig::
40+
41+
+-----------------+
42+
| $ pwd |
43+
| |
44+
| |
45+
+--------+--------+
46+
| $ pwd | $ pwd |
47+
| | |
48+
| | |
49+
+--------+--------+
4650

4751
.. literalinclude:: ../examples/3-pane.yaml
4852
:language: yaml
4953

5054
4 panes
5155
-------
5256

53-
.. aafig::
57+
.. sidebar:: 4 panes
5458

55-
+-----------------+
56-
| $ pwd |
57-
| |
58-
| |
59-
+--------+--------+
60-
| $ pwd | $ pwd |
61-
| | |
62-
| | |
63-
+--------+--------+
59+
.. aafig::
6460

61+
+--------+--------+
62+
| $ pwd | $ pwd |
63+
| | |
64+
| | |
65+
+--------+--------+
66+
| $ pwd | $ pwd |
67+
| | |
68+
| | |
69+
+--------+--------+
6570

6671
.. literalinclude:: ../examples/4-pane.yaml
6772
:language: yaml
6873

74+
Super-advanced dev environment
75+
------------------------------
76+
77+
.. seealso::
78+
:ref:`tmuxp developer config` in the :ref:`developing` section.
79+
80+
.. literalinclude:: ../.tmuxp.yaml
81+
:language: yaml
82+
6983
Kung fu
7084
-------
7185

doc/quickstart.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ It will list configs available in the current directory and
3838
3939
This creates your tmuxp session.
4040

41-
.. seealso:: :ref:`quickstart`
41+
.. seealso:: :ref:`examples`
4242

4343
Bash completion
4444
"""""""""""""""
@@ -80,7 +80,8 @@ Conventions
8080

8181
.. module:: tmuxp
8282

83-
.. seealso:: :ref:`tmuxp python API documentation <api>`
83+
.. seealso::
84+
:ref:`tmuxp python API documentation <api>` and :ref:`developing`.
8485

8586
======================================== =================================
8687
:ref:`tmuxp python api <api>` :term:`tmux(1)` equivalent

0 commit comments

Comments
 (0)