Commit 1e013ff7 authored by Nícolas F. R. A. Prado's avatar Nícolas F. R. A. Prado Committed by Jonathan Corbet

docs: Document cross-referencing using relative path

Update the Cross-referencing section to explain how to create a
cross-reference to a document using relative paths and with no
additional syntax, by relying on automarkup.py.
Signed-off-by: default avatarNícolas F. R. A. Prado <nfraprado@protonmail.com>
Link: https://lore.kernel.org/r/20210128010028.58541-3-nfraprado@protonmail.comSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent ea1d8389
...@@ -340,16 +340,26 @@ Rendered as: ...@@ -340,16 +340,26 @@ Rendered as:
Cross-referencing Cross-referencing
----------------- -----------------
Cross-referencing from one documentation page to another can be done by passing Cross-referencing from one documentation page to another can be done simply by
the path to the file starting from the Documentation folder. writing the path to the document file, no special syntax required. The path can
For example, to cross-reference to this page (the .rst extension is optional):: be either absolute or relative. For absolute paths, start it with
"Documentation/". For example, to cross-reference to this page, all the
See Documentation/doc-guide/sphinx.rst. following are valid options, depending on the current document's directory (note
that the ``.rst`` extension is required)::
If you want to use a relative path, you need to use Sphinx's ``doc`` directive.
For example, referencing this page from the same directory would be done as:: See Documentation/doc-guide/sphinx.rst. This always works.
Take a look at sphinx.rst, which is at this same directory.
See :doc:`sphinx`. Read ../sphinx.rst, which is one directory above.
If you want the link to have a different rendered text other than the document's
title, you need to use Sphinx's ``doc`` role. For example::
See :doc:`my custom link text for document sphinx <sphinx>`.
For most use cases, the former is preferred, as it is cleaner and more suited
for people reading the source files. If you come across a ``:doc:`` usage that
isn't adding any value, please feel free to convert it to just the document
path.
For information on cross-referencing to kernel-doc functions or types, see For information on cross-referencing to kernel-doc functions or types, see
Documentation/doc-guide/kernel-doc.rst. Documentation/doc-guide/kernel-doc.rst.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment