Improve access to table and math markup info in docs

This commit is contained in:
jfbu 2017-06-20 15:57:32 +02:00
parent 6f283d6879
commit adc056200c
3 changed files with 21 additions and 2 deletions

View File

@ -1,5 +1,7 @@
.. highlight:: rest
.. _math-support:
Math support in Sphinx
======================

View File

@ -210,7 +210,17 @@ Including content based on tags
Tables
------
Use :ref:`standard reStructuredText tables <rst-tables>`. They work fine in
Use :ref:`reStructuredText tables <rst-tables>`, i.e. either
- grid table syntax (:duref:`ref <grid-tables>`),
- simple table syntax (:duref:`ref <simple-tables>`),
- :dudir:`csv-table` syntax,
- or :dudir:`list-table` syntax.
The :dudir:`table` directive serves as optional wrapper of the *grid* and
*simple* syntaxes.
They work fine in
HTML output, however there are some gotchas when using tables in LaTeX: the
column width is hard to determine correctly automatically. For this reason, the
following directive exists:
@ -313,6 +323,11 @@ following directive exists:
Sphinx's merged cells interact well with ``p{width}``, ``\X{a}{b}``, ``Y{f}``
and tabulary's columns.
Math
----
See :ref:`math-support`.
.. rubric:: Footnotes
.. [#] For most builders name and format are the same. At the moment only

View File

@ -159,7 +159,7 @@ rendered as "The next paragraph is a code sample:".
Tables
------
Two forms of tables are supported. For *grid tables* (:duref:`ref
For *grid tables* (:duref:`ref
<grid-tables>`), you have to "paint" the cell grid yourself. They look like
this::
@ -185,6 +185,8 @@ contain multiple lines. They look like this::
True True True
===== ===== =======
Two more syntaxes are supported: *CSV tables* and *List tables*. They use an
*explicit markup block*, see `Directives`_ section.
Hyperlinks
----------