diff options
author | shimizukawa <shimizukawa@gmail.com> | 2014-08-24 11:07:36 +0900 |
---|---|---|
committer | shimizukawa <shimizukawa@gmail.com> | 2014-08-24 11:07:36 +0900 |
commit | a518b7cf8f3b8504db65cb81d0c5311594d518a9 (patch) | |
tree | 26f118e525f986f689470f4ea866766a34eb8f63 | |
parent | 514e36e733876ff59219e6a594a535921aafb9f9 (diff) | |
download | sphinx-a518b7cf8f3b8504db65cb81d0c5311594d518a9.tar.gz |
Update CHANGES and documentation for PR#266.
-rw-r--r-- | CHANGES | 6 | ||||
-rw-r--r-- | doc/markup/code.rst | 6 |
2 files changed, 6 insertions, 6 deletions
@@ -36,9 +36,9 @@ Features added like ``-D key=val1,val2``. * #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives to start at an arbitrary line number, with a new ``lineno-start`` option. -* PR#172: The :rst:dir:`code-block` and :rst:dir:`literalinclude` directives now - can have a ``filename`` option that shows a filename before the code in the - output. +* PR#172, PR#266: The :rst:dir:`code-block` and :rst:dir:`literalinclude` + directives now can have a ``caption`` option that shows a filename before the + code in the output. Thanks to Nasimul Haque, Takeshi Komiya. * Prompt for the document language in sphinx-quickstart. * PR#217: Added config values to suppress UUID and location information in generated gettext catalogs. diff --git a/doc/markup/code.rst b/doc/markup/code.rst index c1d9c25f..f69bb161 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -206,16 +206,16 @@ Showing a file name .. versionadded:: 1.3 -A ``filename`` option can be given to show that name before the code block. For +A ``caption`` option can be given to show that name before the code block. For example:: .. code-block:: python - :filename: this.py + :caption: this.py print 'Explicit is better than implicit.' -:rst:dir:`literalinclude` also supports the ``filename`` option, with the +:rst:dir:`literalinclude` also supports the ``caption`` option, with the additional feature that if you leave the value empty, the shown filename will be exactly the one given as an argument. |