File tree 1 file changed +8
-7
lines changed
1 file changed +8
-7
lines changed Original file line number Diff line number Diff line change @@ -661,14 +661,21 @@ Syntax highlighting is handled in a smart way:
661
661
662
662
Longer displays of verbatim text may be included by storing the example text in
663
663
an external file containing only plain text. The file may be included using the
664
- ``literalinclude `` directive. [ 1 ]_ For example, to include the Python source
664
+ ``literalinclude `` directive. For example, to include the Python source
665
665
file :file: `example.py `, use::
666
666
667
667
.. literalinclude:: example.py
668
668
669
669
The file name is relative to the current file's path. Documentation-specific
670
670
include files should be placed in the ``Doc/includes `` subdirectory.
671
671
672
+ .. note ::
673
+
674
+ There is a standard ``include `` directive, but it raises errors if the
675
+ file is not found. ``literalinclude `` is preferred because it only emits a
676
+ warning instead of raising an error.
677
+
678
+
672
679
.. _rest-inline-markup :
673
680
.. _roles :
674
681
@@ -1288,9 +1295,3 @@ default. They are set in the build configuration file :file:`conf.py`.
1288
1295
1289
1296
Replaced by either today's date, or the date set in the build configuration
1290
1297
file. Normally has the format ``April 14, 2007 ``.
1291
-
1292
-
1293
- .. rubric :: Footnotes
1294
-
1295
- .. [1 ] There is a standard ``include `` directive, but it raises errors if the
1296
- file is not found. This one only emits a warning.
You can’t perform that action at this time.
0 commit comments