diff options
| author | Nícolas F. R. A. Prado <nfraprado@protonmail.com> | 2020-09-11 13:34:39 +0000 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-09-16 11:09:51 -0600 |
| commit | d18b01789ae5abba2ce8dd23c984926eca3925a9 (patch) | |
| tree | 30a4208d0eb4f70b34f87eb3e60183718676a303 /Documentation/doc-guide | |
| parent | 1ac4cfb2ce03e1a7382c64fe73c9e16c0acc20db (diff) | |
docs: Add automatic cross-reference for documentation pages
Cross-referencing to other documentation pages is possible using the
:doc:`doc-file` directive from Sphinx.
Add automatic markup for references to other documentation pages in the
format Documentation/subfolder/doc-file.rst (the extension being
optional).
This requires that the path be passed all the way from the Documentation
folder, which can be longer than passing a relative path through the
:doc: directive, but avoids the markup, making the text cleaner when
read in plain text.
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
Link: https://lore.kernel.org/r/20200911133339.327721-3-nfraprado@protonmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
0 files changed, 0 insertions, 0 deletions