The useful content in the user guide is all being moved to project-specific docsets. We can remove the guide here, and replace it with a /user/ landing page that provides links to all of the known user guides for services and clients. Change-Id: I7005b4288b94e755f406fd6a8e3273265b643042 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2.1 KiB
References
Cross-references
To cross-reference to arbitrary locations within one document, 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.
Input
.. _cg_titles:
Titles
~~~~~~
This is the section we want to reference to.
...
The following - :ref:`cg_titles` - generates a link to the section with
the defined label using this section heading as a link title.
A link label and a reference can be defined in separate source files,
but within one directory. Otherwise, use the external linking.
Output
...
The following - cg_titles
- generates a link to the section with the
defined label using this section heading as a link title.
A link label and a reference can be defined in separate source files, but within one directory. Otherwise, use the external linking.
External references
To link to some external locations, format the RST source as follows:
- Do not apply any markups to specify a web link.
- If you need a specific link title to appear in the output, format a
web link as
Link text <http://web-link.com>
wrapping it in backticks. - Do not separate the link name from the link itself by defining the link in another place in your document. It prevents translated documents from using different links, for example, corresponding links to translated versions.
Input
Here is a link to the Image guide: https://docs.openstack.org/image-guide/.
Here is an external web link with a link title:
`Image guide <https://docs.openstack.org/image-guide/>`_.
Output
Here is a link to the Image guide: https://docs.openstack.org/image-guide/.
Here is an external web link with a link title: Image guide.