Nicholas Chin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/84069?usp=email )
Change subject: Docs/conf.py: Explicitly define external URL schemes ......................................................................
Docs/conf.py: Explicitly define external URL schemes
By default, any URL with a scheme of "http", "https", "ftp", or "mailto" is treated as an external link. Since the "ircs" scheme is not included, the IRC link in community/forums.md does not get resolved as an external link, and instead tries to link to a header in the docs themselves. Fix this by explicitly defining which schemes should resolve to external links using the myst_url_schemes configuration option [1], which is now set to the default schemes along with "ircs".
This fixes the "cross-reference target not found" warning for 'ircs://irc.libera.chat/#coreboot'
[1] https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#c...
Change-Id: I9e1c76b2bacbacaa06340f940c76b50de38e43e8 Signed-off-by: Nicholas Chin nic.c3.14@gmail.com --- M Documentation/conf.py 1 file changed, 1 insertion(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/69/84069/1
diff --git a/Documentation/conf.py b/Documentation/conf.py index b0f2975..6284fca 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -23,6 +23,7 @@ extensions = ["myst_parser"]
myst_heading_anchors = 5 +myst_url_schemes = ["http", "https", "mailto", "ftp", "ircs"]
templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']