summaryrefslogtreecommitdiff
path: root/doc/markup/para.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-01-04 22:00:40 +0100
committerGeorg Brandl <georg@python.org>2009-01-04 22:00:40 +0100
commitafc0d3fbc313eaca17aee86cbb0993d4f92d55c9 (patch)
tree19dccceb983e578a6ecc8575ebef9066b338ada9 /doc/markup/para.rst
parentafaacbd66760f8ce11ec8d7ea2cdd3d7b22fe3e8 (diff)
downloadsphinx-afc0d3fbc313eaca17aee86cbb0993d4f92d55c9.tar.gz
Close #52: There is now a ``hlist`` directive, creating a compact
list by placing distributing items into multiple columns.
Diffstat (limited to 'doc/markup/para.rst')
-rw-r--r--doc/markup/para.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/markup/para.rst b/doc/markup/para.rst
index c60eb258..b071e46c 100644
--- a/doc/markup/para.rst
+++ b/doc/markup/para.rst
@@ -100,6 +100,27 @@ units as well as normal text:
.. centered:: LICENSE AGREEMENT
+.. directive:: hlist
+
+ This directive must contain a bullet list. It will transform it into a more
+ compact list by either distributing more than one item horizontally, or
+ reducing spacing between items, depending on the builder.
+
+ For builders that support the horizontal distribution, there is a ``columns``
+ option that specifies the number of columns; it defaults to 2. Example::
+
+ .. hlist::
+ :columns: 3
+
+ * A list of
+ * short items
+ * that should be
+ * displayed
+ * horizontally
+
+ .. versionadded:: 0.6
+
+
Table-of-contents markup
------------------------