Skip to content

Commit 7ab00c2

Browse files
committed
docs: Section headings.
1 parent fc6c167 commit 7ab00c2

File tree

5 files changed

+49
-71
lines changed

5 files changed

+49
-71
lines changed

doc/about_tmux.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _about_tmux:
22

3-
===============
3+
###############
44
The Tao of tmux
5-
===============
5+
###############
66

77
.. figure:: _static/tao-tmux-screenshot.png
88
:scale: 60%
@@ -29,6 +29,7 @@ the text dimension. Inside tmux you can:
2929
- have multiple windows (window) in the workspace (session)
3030
- switch between multiple workspaces, like virtual desktops
3131

32+
=============
3233
Thinking Tmux
3334
=============
3435

@@ -212,6 +213,7 @@ Multitasking. Preserving the thinking you have.
212213

213214
.. _"train of thought": http://en.wikipedia.org/wiki/Train_of_thought
214215

216+
===============
215217
Installing tmux
216218
===============
217219

@@ -238,6 +240,7 @@ If **compiling from source**, the dependencies are `libevent`_ and
238240
.. _Fink: http://fink.thetis.ig42.org/
239241
.. _Homebrew: http://www.brew.sh
240242

243+
==========
241244
Using tmux
242245
==========
243246

@@ -497,15 +500,16 @@ Short cut Action
497500
``"`` Split the current pane into two, top and bottom.
498501
=================== ====================================================
499502

500-
Tmux configuration
501-
==================
503+
================
504+
Configuring Tmux
505+
================
502506

503507
Tmux can be configured via a configuration at ``~/.tmux.conf``.
504508

505509
Depending on your tmux version, there is different options available.
506510

507-
Vi copypaste
508-
------------
511+
Vi-style copy and paste
512+
-----------------------
509513

510514
.. code-block:: ini
511515
@@ -562,6 +566,7 @@ Examples
562566
uptime stats.
563567
- Add yours, edit this page on github.
564568

569+
=========
565570
Reference
566571
=========
567572

@@ -643,8 +648,9 @@ Source: tmux manpage [1]_.
643648
644649
$ nroff -mdoc tmux.1|less
645650
651+
=======
646652
License
647-
-------
653+
=======
648654

649655
This page is licensed `Creative Commons BY-NC-ND 3.0 US`_.
650656

doc/cli.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Command Line Interface
77
.. _bash_completion:
88

99
Bash completion
10-
"""""""""""""""
10+
---------------
1111

1212
For bash, ``.bashrc``:
1313

@@ -33,7 +33,7 @@ For zsh, ``.zshrc``:
3333
.. _cli_freeze:
3434

3535
Freeze sessions
36-
"""""""""""""""
36+
---------------
3737

3838
.. argparse::
3939
:module: tmuxp.cli
@@ -49,7 +49,7 @@ Freeze sessions
4949
.. _cli_load:
5050

5151
Load session
52-
""""""""""""
52+
------------
5353

5454
.. argparse::
5555
:module: tmuxp.cli
@@ -76,12 +76,12 @@ Load session
7676
.. _cli_import:
7777

7878
Import
79-
""""""
79+
------
8080

8181
.. _import_teamocil:
8282

8383
From teamocil
84-
'''''''''''''
84+
~~~~~~~~~~~~~
8585

8686
.. argparse::
8787
:module: tmuxp.cli
@@ -92,7 +92,7 @@ From teamocil
9292
.. _import_tmuxinator:
9393

9494
From tmuxinator
95-
'''''''''''''''
95+
~~~~~~~~~~~~~~~
9696

9797
.. argparse::
9898
:module: tmuxp.cli
@@ -103,7 +103,7 @@ From tmuxinator
103103
.. _convert_config:
104104

105105
Convert between YAML and JSON
106-
"""""""""""""""""""""""""""""
106+
-----------------------------
107107

108108
.. argparse::
109109
:module: tmuxp.cli
@@ -116,7 +116,7 @@ Convert between YAML and JSON
116116
``.json`` to ``.yaml``.
117117

118118
Other commands
119-
""""""""""""""
119+
--------------
120120

121121
.. argparse::
122122
:module: tmuxp.cli

doc/developing.rst

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ If you found a problem or are trying to write a test, you can file an
7474
.. _test_specific_tests:
7575

7676
Test runner options
77-
"""""""""""""""""""
77+
~~~~~~~~~~~~~~~~~~~
7878

7979
.. note::
8080

@@ -109,7 +109,7 @@ Multiple can be separated by spaces:
109109
.. _test_builder_visually:
110110

111111
Visual testing
112-
''''''''''''''
112+
~~~~~~~~~~~~~~
113113

114114
You can watch tmux testsuite build sessions visually by keeping a client
115115
open in a separate terminal.
@@ -128,34 +128,6 @@ Create two terminals:
128128
Terminal 1 should have flickered and built the session before your eyes.
129129
tmuxp hides this building from normal users.
130130

131-
Verbosity and logging
132-
'''''''''''''''''''''
133-
134-
``./run-tests.py`` supports two options, these are *optional* flags that
135-
may be added to for :ref:`test_specific_tests` and
136-
:ref:`test_builder_visually`.
137-
138-
1. log level: ``-l`` aka ``--log-level``, with the options of ``debug``,
139-
``info``, ``warn``, ``error``, ``fatal``. Default is ``INFO``.
140-
141-
.. code-block:: bash
142-
143-
$ ./run-tests.py --log-level debug
144-
145-
short form:
146-
147-
.. code-block:: bash
148-
149-
$ ./run-tests.py -l debug
150-
151-
2. unit test verbosity:
152-
153-
``--verbosity`` may be set to ``0``, ``1`` and ``2``. Default: ``2``.
154-
155-
.. code-block:: bash
156-
157-
$ ./run-tests.py --verbosity 0
158-
159131
Run tests on save
160132
-----------------
161133

@@ -188,7 +160,7 @@ To run test where :ref:`test_builder_visually` you may:
188160
.. _tmuxp developer config:
189161

190162
tmuxp developer config
191-
""""""""""""""""""""""
163+
----------------------
192164

193165
.. image:: _static/tmuxp-dev-screenshot.png
194166
:scale: 100%
@@ -209,7 +181,7 @@ this will load the ``.tmuxp.yaml`` in the root of the project.
209181
.. _travis:
210182

211183
Travis CI
212-
"""""""""
184+
~~~~~~~~~
213185

214186
tmuxp uses `travis-ci`_ for continuous integration / automatic unit
215187
testing.

doc/examples.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ punctual.
2727
+-------------------+
2828

2929
YAML
30-
""""
30+
~~~~
3131

3232
.. literalinclude:: ../examples/shorthands.yaml
3333
:language: yaml
3434

3535
JSON
36-
""""
36+
~~~~
3737

3838
.. literalinclude:: ../examples/shorthands.json
3939
:language: json
@@ -47,13 +47,13 @@ No need to repeat ``pwd`` or a dummy command. A ``null``, ``'blank'``,
4747
Note ``''`` counts as an empty carriage return.
4848

4949
YAML
50-
""""
50+
~~~~
5151

5252
.. literalinclude:: ../examples/blank-panes.yaml
5353
:language: yaml
5454

5555
JSON
56-
""""
56+
~~~~
5757

5858
.. literalinclude:: ../examples/blank-panes.json
5959
:language: json
@@ -76,13 +76,13 @@ JSON
7676
+-----------------+
7777

7878
YAML
79-
""""
79+
~~~~
8080

8181
.. literalinclude:: ../examples/2-pane-vertical.yaml
8282
:language: yaml
8383

8484
JSON
85-
""""
85+
~~~~
8686

8787
.. literalinclude:: ../examples/2-pane-vertical.json
8888
:language: json
@@ -105,13 +105,13 @@ JSON
105105
+--------+--------+
106106

107107
YAML
108-
""""
108+
~~~~
109109

110110
.. literalinclude:: ../examples/3-pane.yaml
111111
:language: yaml
112112

113113
JSON
114-
""""
114+
~~~~
115115

116116
.. literalinclude:: ../examples/3-pane.json
117117
:language: json
@@ -134,13 +134,13 @@ JSON
134134
+--------+--------+
135135

136136
YAML
137-
""""
137+
~~~~
138138

139139
.. literalinclude:: ../examples/4-pane.yaml
140140
:language: yaml
141141

142142
JSON
143-
""""
143+
~~~~
144144

145145
.. literalinclude:: ../examples/4-pane.json
146146
:language: json
@@ -151,13 +151,13 @@ Start Directory
151151
Equivalent to ``tmux new-window -c <start-directory>``.
152152

153153
YAML
154-
""""
154+
~~~~
155155

156156
.. literalinclude:: ../examples/start-directory.yaml
157157
:language: yaml
158158

159159
JSON
160-
""""
160+
~~~~
161161

162162
.. literalinclude:: ../examples/start-directory.json
163163
:language: json
@@ -169,13 +169,13 @@ tmuxp allows ``focus: true`` for assuring windows and panes are attached /
169169
selected upon loading.
170170

171171
YAML
172-
""""
172+
~~~~
173173

174174
.. literalinclude:: ../examples/focus-window-and-panes.yaml
175175
:language: yaml
176176

177177
JSON
178-
""""
178+
~~~~
179179

180180
.. literalinclude:: ../examples/focus-window-and-panes.json
181181
:language: json
@@ -187,13 +187,13 @@ You can specify a window's index using the ``window_index`` property. Windows
187187
without ``window_index`` will use the lowest available window index.
188188

189189
YAML
190-
""""
190+
~~~~
191191

192192
.. literalinclude:: ../examples/window-index.yaml
193193
:language: yaml
194194

195195
JSON
196-
""""
196+
~~~~
197197

198198
.. literalinclude:: ../examples/window-index.json
199199
:language: json
@@ -202,13 +202,13 @@ Automatic Rename
202202
----------------
203203

204204
YAML
205-
""""
205+
~~~~
206206

207207
.. literalinclude:: ../examples/automatic-rename.yaml
208208
:language: yaml
209209

210210
JSON
211-
""""
211+
~~~~
212212

213213
.. literalinclude:: ../examples/automatic-rename.json
214214
:language: json
@@ -217,13 +217,13 @@ Main pane height
217217
----------------
218218

219219
YAML
220-
""""
220+
~~~~
221221

222222
.. literalinclude:: ../examples/main-pane-height.yaml
223223
:language: yaml
224224

225225
JSON
226-
""""
226+
~~~~
227227

228228
.. literalinclude:: ../examples/main-pane-height.json
229229
:language: json
@@ -235,13 +235,13 @@ Super-advanced dev environment
235235
:ref:`tmuxp developer config` in the :ref:`developing` section.
236236

237237
YAML
238-
""""
238+
~~~~
239239

240240
.. literalinclude:: ../.tmuxp.yaml
241241
:language: yaml
242242

243243
JSON
244-
""""
244+
~~~~
245245

246246
.. literalinclude:: ../.tmuxp.json
247247
:language: json

0 commit comments

Comments
 (0)