Add a note about substitutions.

This commit is contained in:
Georg Brandl 2008-10-25 16:00:53 +00:00
parent 29a3a86cef
commit 3206a6ab6f
2 changed files with 23 additions and 0 deletions

View File

@ -350,6 +350,7 @@ The following roles generate external links:
Note that there are no special roles for including hyperlinks as you can use Note that there are no special roles for including hyperlinks as you can use
the standard reST markup for that purpose. the standard reST markup for that purpose.
.. _default-substitutions:
Substitutions Substitutions
------------- -------------

View File

@ -270,6 +270,28 @@ Citation usage is similar to footnote usage, but with a label that is not
numeric or begins with ``#``. numeric or begins with ``#``.
Substitutions
-------------
reST supports "substitutions", which are pieces of text and/or markup referred
to in the text by ``|name|``. They are defined like footnotes with explicit
markup blocks, like this::
.. |name| replace:: replacement *text*
See the `reST reference for substitutions
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions>`_
for details.
If you want to use some substitutions for all documents, put them into a
separate file and include it into all documents you want to use them in, using
the :dir:`include` directive. Be sure to give the include file a file name
extension differing from that of other source files, to avoid Sphinx finding it
as a standalone document.
Sphinx defines some default substitutions, see :ref:`default-substitutions`.
Comments Comments
-------- --------