IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update CHANGES and documentation for PR#266.

Browse Source
This commit is contained in:
Takayuki Shimizukawa 2014-08-24 11:07:36 +09:00
parent 8536b4844e
commit a2410ec2ee
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGES
View File

@ -36,9 +36,9 @@ Features added
like ``-D key=val1,val2``. like ``-D key=val1,val2``.
* #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives * #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives
to start at an arbitrary line number, with a new ``lineno-start`` option. 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 * PR#172, PR#266: The :rst:dir:`code-block` and :rst:dir:`literalinclude`
can have a ``filename`` option that shows a filename before the code in the directives now can have a ``caption`` option that shows a filename before the
output. code in the output. Thanks to Nasimul Haque, Takeshi Komiya.
* Prompt for the document language in sphinx-quickstart. * Prompt for the document language in sphinx-quickstart.
* PR#217: Added config values to suppress UUID and location information in * PR#217: Added config values to suppress UUID and location information in
generated gettext catalogs. generated gettext catalogs.

6
doc/markup/code.rst
View File

@ -206,16 +206,16 @@ Showing a file name
.. versionadded:: 1.3 .. 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:: example::
.. code-block:: python .. code-block:: python
:filename: this.py :caption: this.py
print 'Explicit is better than implicit.' 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 additional feature that if you leave the value empty, the shown filename will be
exactly the one given as an argument. exactly the one given as an argument.