From a2410ec2ee39f2317d42bd76da51ceba14f69e95 Mon Sep 17 00:00:00 2001 From: Takayuki Shimizukawa Date: Sun, 24 Aug 2014 11:07:36 +0900 Subject: [PATCH] Update CHANGES and documentation for PR#266. --- CHANGES | 6 +++--- doc/markup/code.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGES b/CHANGES index b69c2bb71..2dd68ec36 100644 --- a/CHANGES +++ b/CHANGES @@ -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 c1d9c25f4..f69bb161b 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.