Skip to content

Footnotes are discouraged #1290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions documentation/markup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -661,14 +661,21 @@ Syntax highlighting is handled in a smart way:

Longer displays of verbatim text may be included by storing the example text in
an external file containing only plain text. The file may be included using the
``literalinclude`` directive. [1]_ For example, to include the Python source
``literalinclude`` directive. For example, to include the Python source
file :file:`example.py`, use::

.. literalinclude:: example.py

The file name is relative to the current file's path. Documentation-specific
include files should be placed in the ``Doc/includes`` subdirectory.

.. note::

There is a standard ``include`` directive, but it raises errors if the
file is not found. ``literalinclude`` is preferred because it only emits a
warning instead of raising an error.


.. _rest-inline-markup:
.. _roles:

Expand Down Expand Up @@ -1288,9 +1295,3 @@ default. They are set in the build configuration file :file:`conf.py`.

Replaced by either today's date, or the date set in the build configuration
file. Normally has the format ``April 14, 2007``.


.. rubric:: Footnotes

.. [1] There is a standard ``include`` directive, but it raises errors if the
file is not found. This one only emits a warning.