openstack/openstack-manuals
Code Issues Proposed changes

[contributor] add more details about RST reference

Browse Source 
Change-Id: I4c968cc476b87d38a97bf57a2686d0cb88f7473e
Closes-Bug: #1671068
This commit is contained in:
KATO Tomoyuki 2017-03-09 22:16:16 +09:00 committed by Andreas Jaeger
parent adcdf453a1
commit 2c8fa4120f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/contributor-guide/source/rst-conv/references.rst
View File

@ -6,7 +6,12 @@ Cross-references
~~~~~~~~~~~~~~~~
To cross-reference to arbitrary locations within one document,
use the ``ref`` role:
use the ``ref`` role.
Reference target names need to start with an underscore.
For example, ``.. _example:``. However, the reference itself should not
have the underscore preceding the reference. For example, ``example``.
For more information on referencing, see `Internal Hyperlink Targets
<http://docutils.sourceforge.net/docs/user/rst/quickref.html#internal-hyperlink-targets>`_.
**Input**