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

Merge pull request #7798 from stefanodavid/code-block-crossref-doc

Browse Source 
documentation for proper code-block cross-referencing
This commit is contained in:
Takeshi KOMIYA 2021-01-23 22:31:02 +09:00 committed by GitHub
commit f707cb30a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/usage/restructuredtext/directives.rst
View File

@ -571,6 +571,20 @@ __ http://pygments.org/docs/lexers
.. versionadded:: 1.3 .. versionadded:: 1.3
In order to cross-reference a code-block using either the
:rst:role:`ref` or the :rst:role:`numref` role, it is necessary
that both :strong:`name` and :strong:`caption` be defined. The
argument of :strong:`name` can then be given to :rst:role:`numref`
to generate the cross-reference. Example::
See :numref:`this-py` for an example.
When using :rst:role:`ref`, it is possible to generate a cross-reference
with only :strong:`name` defined, provided an explicit title is
given. Example::
See :ref:`this code snippet <this-py>` for an example.
.. rst:directive:option:: dedent: number .. rst:directive:option:: dedent: number
:type: number or no value :type: number or no value