Add :filename: also for literalinclude. Changelog entry.

This commit is contained in:
Georg Brandl
2014-01-19 11:04:12 +01:00
parent 883b960cb1
commit 2458e5731a
3 changed files with 29 additions and 0 deletions

View File

@@ -188,6 +188,25 @@ Includes
The ``prepend`` and ``append`` options, as well as ``tab-width``.
Showing a file name
^^^^^^^^^^^^^^^^^^^
.. versionadded:: 1.3
A ``filename`` option can be given to show that name before the code block. For
example::
.. code-block:: python
:filename: this.py
print 'Explicit is better than implicit.'
:rst:dir:`literalinclude` also supports the ``filename`` option, with the
additional feature that if you leave the value empty, the shown filename will be
exactly the one given as an argument.
.. rubric:: Footnotes
.. [1] There is a standard ``.. include`` directive, but it raises errors if the