Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: Enable usage of relative paths to docs on automarkup

Previously, a cross-reference to another document could only be created
by writing the full path to the document starting from the
Documentation/ directory.

Extend this to also allow relative paths to be used. A relative path
would be just the path, like ../filename.rst, while the absolute path
still needs to start from Documentation, like Documentation/filename.rst.

As part of this change, the .rst extension is now required for both
types of paths, since not requiring it would cause the regex to be too
generic.

Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
Link: https://lore.kernel.org/r/20210128010028.58541-2-nfraprado@protonmail.com
[jc: Tweaked the regex to recognize .txt too]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Nícolas F. R. A. Prado and committed by
Jonathan Corbet
ea1d8389 8fa4e938

+5 -2
+5 -2
Documentation/sphinx/automarkup.py
··· 51 51 # Detects a reference to a documentation page of the form Documentation/... with 52 52 # an optional extension 53 53 # 54 - RE_doc = re.compile(r'\bDocumentation(/[\w\-_/]+)(\.\w+)*') 54 + RE_doc = re.compile(r'(\bDocumentation/)?((\.\./)*[\w\-/]+)\.(rst|txt)') 55 55 56 56 RE_namespace = re.compile(r'^\s*..\s*c:namespace::\s*(\S+)\s*$') 57 57 ··· 234 234 # 235 235 # Go through the dance of getting an xref out of the std domain 236 236 # 237 - target = match.group(1) 237 + absolute = match.group(1) 238 + target = match.group(2) 239 + if absolute: 240 + target = "/" + target 238 241 xref = None 239 242 pxref = addnodes.pending_xref('', refdomain = 'std', reftype = 'doc', 240 243 reftarget = target, modname = None,