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 @@ -699,14 +699,21 @@ Syntax highlighting is handled in a smart way:
699
699
700
700
Longer displays of verbatim text may be included by storing the example text in
701
701
an external file containing only plain text. The file may be included using the
702
- ``literalinclude `` directive. [ 1 ]_ For example, to include the Python source
702
+ ``literalinclude `` directive. For example, to include the Python source
703
703
file :file: `example.py `, use::
704
704
705
705
.. literalinclude:: example.py
706
706
707
707
The file name is relative to the current file's path. Documentation-specific
708
708
include files should be placed in the ``Doc/includes `` subdirectory.
709
709
710
+ .. note ::
711
+
712
+ There is a standard ``include `` directive, but it raises errors if the
713
+ file is not found. ``literalinclude `` is preferred because it only emits a
714
+ warning instead of raising an error.
715
+
716
+
710
717
.. _rest-inline-markup :
711
718
.. _roles :
712
719
@@ -1326,9 +1333,3 @@ default. They are set in the build configuration file :file:`conf.py`.
1326
1333
1327
1334
Replaced by either today's date, or the date set in the build configuration
1328
1335
file. Normally has the format ``April 14, 2007 ``.
1329
-
1330
-
1331
- .. rubric :: Footnotes
1332
-
1333
- .. [1 ] There is a standard ``include `` directive, but it raises errors if the
1334
- file is not found. This one only emits a warning.
You can’t perform that action at this time.
0 commit comments