diff options
Diffstat (limited to 'doc/markup')
-rw-r--r-- | doc/markup/code.rst | 2 | ||||
-rw-r--r-- | doc/markup/inline.rst | 11 | ||||
-rw-r--r-- | doc/markup/misc.rst | 11 | ||||
-rw-r--r-- | doc/markup/toctree.rst | 10 |
4 files changed, 27 insertions, 7 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst index 6e8028fe4..c7cb0f911 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -241,7 +241,7 @@ Dedent .. versionadded:: 1.3 -A ``dedent`` option can be given to strip a precedence characters from the code +A ``dedent`` option can be given to strip indentation characters from the code block. For example:: .. literalinclude:: example.rb diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index ae47f820d..bd02dfa08 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -212,15 +212,18 @@ Cross-referencing figures by figure number .. versionadded:: 1.3 +.. versionchanged:: 1.5 + `numref` role can also refer sections. + .. rst:role:: numref - Link to the specified figures, tables and code-blocks; the standard reST - labels are used. When you use this role, it will insert a reference to the - figure with link text by its figure number like "Fig. 1.1". + Link to the specified figures, tables, code-blocks and sections; the standard + reST labels are used. When you use this role, it will insert a reference to + the figure with link text by its figure number like "Fig. 1.1". If an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig. %s) <my-figure>```), the link caption will be the title of the reference. - As a special character, `%s` will be replaced to figure number. + The format of link text is same as :confval:`numfig_format`. If :confval:`numfig` is ``False``, figures are not numbered. so this role inserts not a reference but labels or link text. diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 1f9f446f1..bdfc3346c 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -238,10 +238,19 @@ following directive exists: By default, Sphinx uses a table layout with ``L`` for every column. + .. hint:: + + For columns which are known to be much narrower than the others it is + recommended to use the lowercase specifiers. For more information, check + the ``tabulary`` manual. + .. versionadded:: 0.3 .. warning:: + Tables with more than 30 rows are rendered using ``longtable``, not + ``tabulary``, in order to allow pagebreaks. + Tables that contain list-like elements such as object descriptions, blockquotes or any kind of lists cannot be set out of the box with ``tabulary``. They are therefore set with the standard LaTeX ``tabular`` @@ -253,8 +262,6 @@ following directive exists: literal block are always set with ``tabular``. Also, the verbatim environment used for literal blocks only works in ``p{width}`` columns, which means that by default, Sphinx generates such column specs for such tables. - Use the :rst:dir:`tabularcolumns` directive to get finer control over such - tables. .. rubric:: Footnotes diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst index b4c7105fd..a0161ee3c 100644 --- a/doc/markup/toctree.rst +++ b/doc/markup/toctree.rst @@ -123,6 +123,16 @@ tables of contents. The ``toctree`` directive is the central element. toctree directive. This is useful if you want to generate a "sitemap" from the toctree. + You can use the ``reversed`` flag option to reverse the order of the entries + in the list. This can be useful when using the ``glob`` flag option to + reverse the ordering of the files. Example:: + + .. toctree:: + :glob: + :reversed: + + recipe/* + You can also give a "hidden" option to the directive, like this:: .. toctree:: |