diff options
author | georg.brandl <devnull@localhost> | 2008-10-25 16:00:53 +0000 |
---|---|---|
committer | georg.brandl <devnull@localhost> | 2008-10-25 16:00:53 +0000 |
commit | c67de159914dbc7d2e880a2c7394a6d7523f797d (patch) | |
tree | ac41ac23c0052725c7063747c0dd6a331f9e51ab /doc/rest.rst | |
parent | a03a9f1e3c032681a42673de94b2c5acb91361ee (diff) | |
download | sphinx-c67de159914dbc7d2e880a2c7394a6d7523f797d.tar.gz |
Add a note about substitutions.
Diffstat (limited to 'doc/rest.rst')
-rw-r--r-- | doc/rest.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/rest.rst b/doc/rest.rst index 6040c72e..ad1c695c 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -270,6 +270,28 @@ Citation usage is similar to footnote usage, but with a label that is not 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 -------- |