linux/Documentation/sphinx
Nícolas F. R. A. Prado d18b01789a 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>
2020-09-16 11:09:51 -06:00
..
automarkup.py docs: Add automatic cross-reference for documentation pages 2020-09-16 11:09:51 -06:00
cdomain.py docs: cdomain.py: get rid of a warning since version 1.8 2019-05-29 15:47:32 -06:00
kernel_include.py docs: sphinx-extensions: add metadata parallel-safe 2016-09-01 08:19:02 -06:00
kerneldoc.py kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers' 2019-11-07 13:17:25 -07:00
kernellog.py doc: Cope with Sphinx logging deprecations 2019-05-23 09:22:00 -06:00
kfigure.py Replace HTTP links with HTTPS ones: documentation 2020-06-08 09:30:19 -06:00
load_config.py docs: load_config.py: ensure subdirs end with "/" 2019-07-19 08:49:27 -03:00
maintainers_include.py doc-rst: Programmatically render MAINTAINERS into ReST 2019-10-02 10:03:17 -06:00
parallel-wrapper.sh docs: Fix empty parallelism argument 2020-02-25 03:11:04 -07:00
parse-headers.pl Replace HTTP links with HTTPS ones: Documentation/sphinx/parse-headers.pl 2020-06-26 10:57:33 -06:00
requirements.txt docs: update recommended Sphinx version to 2.4.4 2020-04-20 15:35:58 -06:00
rstFlatTable.py Documentation: rstFlatTable.py: fix a broken reference 2018-06-15 18:10:01 -03:00