File tree Expand file tree Collapse file tree 3 files changed +22
-11
lines changed
doc/contributing/docs/markup Expand file tree Collapse file tree 3 files changed +22
-11
lines changed Original file line number Diff line number Diff line change
1
+ .. container :: table
2
+
3
+ .. list-table ::
4
+ :widths: 25 75
5
+ :header-rows: 1
6
+
7
+ * - Name
8
+ - Use
9
+
10
+ * - :doc: `/reference/reference_lua/box_ctl/wait_ro `
11
+ - Wait until ``box.info.ro `` is true
Original file line number Diff line number Diff line change @@ -11,11 +11,11 @@ Text can be organized in bullet-lists:
11
11
12
12
.. code-block :: rst
13
13
14
- - This is a bullet list.
14
+ * This is a bullet list.
15
15
16
- - Bullets can be "*", "+", or "-".
16
+ * Bullets can be "*", "+", or "-".
17
17
18
- * Lists can be nested. And it is good to indent them with 4 spaces.
18
+ - Lists can be nested. And it is good to indent them with 4 spaces.
19
19
20
20
or in enumerated lists:
21
21
Original file line number Diff line number Diff line change @@ -5,15 +5,15 @@ Tables are very useful and rST markup
5
5
`offers <https://docutils.sourceforge.io/docs/ref/rst/directives.html#tables >`_
6
6
different ways to create them.
7
7
8
- We prefer list-tables to create table of contents:
8
+ We prefer list-tables because they allow you to put as much content as you need
9
+ without painting ASCII-style borders:
9
10
10
- .. code-block :: rst
11
+ .. literalinclude :: _includes/table.rst
12
+ :language: rst
11
13
12
- .. container:: table
14
+ This is how the table will look like:
13
15
14
- .. list-table::
15
- :widths: 25 75
16
- :header-rows: 1
16
+ .. include :: _includes/table.rst
17
17
18
- * - Name
19
- - Use
18
+ Notice that we use `` * `` and then `` - `` in tables because it is more readable
19
+ when rows and columns marked differently.
You can’t perform that action at this time.
0 commit comments