mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
refs #1742: :name: option is provided for toctree, code-block and literalinclude dirctives.
This commit is contained in:
@@ -85,10 +85,13 @@ tables of contents. The ``toctree`` directive is the central element.
|
||||
|
||||
**Additional options**
|
||||
|
||||
You can use ``caption`` option to provide toctree caption::
|
||||
You can use ``caption`` option to provide toctree caption and you can use
|
||||
``name`` option to provide implicit target name that can be referenced by
|
||||
using :rst:role:`ref`::
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
:name: mastertoc
|
||||
|
||||
foo
|
||||
|
||||
@@ -176,7 +179,7 @@ tables of contents. The ``toctree`` directive is the central element.
|
||||
Added "includehidden" option.
|
||||
|
||||
.. versionchanged:: 1.3
|
||||
Added "caption" option.
|
||||
Added "caption" and "name" option.
|
||||
|
||||
Special names
|
||||
-------------
|
||||
|
||||
Reference in New Issue
Block a user