IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix #4420: Docs conflict on use of rst_prolog and rst_epilog

Browse Source
This commit is contained in:
Gussie Carther
2018-04-14 17:51:06 +09:00
parent 557514330f
commit 390ea6d35a
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/usage/restructuredtext/basics.rst
View File

@@ -508,11 +508,14 @@ or this::
See the :duref:`reST reference for substitutions <substitution-definitions>`
for details.
.. index:: ! pair: global; substitutions
If you want to use some substitutions for all documents, put them into
:confval:`rst_prolog` or put them into a separate file and include it into all
documents you want to use them in, using the :rst: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.)
:confval:`rst_prolog` or :confval:`rst_epilog` or put them into a separate file
and include it into all documents you want to use them in, using the
:rst: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`.