diff --git a/doc/rest.rst b/doc/rest.rst index db832ed82..ccf51c66f 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -265,8 +265,9 @@ Docutils supports the following directives: * Admonitions: :dudir:`attention`, :dudir:`caution`, :dudir:`danger`, :dudir:`error`, :dudir:`hint`, :dudir:`important`, :dudir:`note`, - :dudir:`tip`, :dudir:`warning` and the generic :dudir:`admonition`. - (Most themes style only "note" and "warning" specially.) + :dudir:`tip`, :dudir:`warning` and the generic + :dudir:`admonition `. (Most themes style only "note" and + "warning" specially.) * Images: @@ -285,7 +286,7 @@ Docutils supports the following directives: - :dudir:`epigraph` (a block quote with optional attribution line) - :dudir:`highlights`, :dudir:`pull-quote` (block quotes with their own class attribute) - - :dudir:`compound` (a compound paragraph) + - :dudir:`compound ` (a compound paragraph) * Special tables: @@ -295,7 +296,7 @@ Docutils supports the following directives: * Special directives: - - :dudir:`raw` (include raw target-format markup) + - :dudir:`raw ` (include raw target-format markup) - :dudir:`include` (include reStructuredText from another file) -- in Sphinx, when given an absolute include file path, this directive takes it as relative to the source directory @@ -304,7 +305,7 @@ Docutils supports the following directives: * HTML specifics: - :dudir:`meta` (generation of HTML ```` tags) - - :dudir:`title` (override document title) + - :dudir:`title ` (override document title) * Influencing markup: @@ -472,9 +473,8 @@ There are some problems one commonly runs into while authoring reST documents: * **Separation of inline markup:** As said above, inline markup spans must be separated from the surrounding text by non-word characters, you have to use a - backslash-escaped space to get around that. See `the reference - `_ - for the details. + backslash-escaped space to get around that. See + :duref:`the reference ` for the details. * **No nested inline markup:** Something like ``*see :func:`foo`*`` is not possible.