docs: Enable usage of relative paths to docs on automarkup
authorNícolas F. R. A. Prado <nfraprado@protonmail.com>
Thu, 28 Jan 2021 01:01:25 +0000 (01:01 +0000)
committerJonathan Corbet <corbet@lwn.net>
Thu, 4 Feb 2021 23:23:43 +0000 (16:23 -0700)
commitea1d838980f4afe457a48773dfe142af58aba8bd
tree41c1d26b90839b2cf7f964538bc542a297999df1
parent8fa4e9388006bd2964e39cba241d8e59e5641438
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>
Documentation/sphinx/automarkup.py