diff options
| author | Nicholas Chin <nic.c3.14@gmail.com> | 2024-08-23 19:35:51 -0600 |
|---|---|---|
| committer | Nico Huber <nico.h@gmx.de> | 2024-08-25 15:20:37 +0000 |
| commit | 2b45b7a54b65ff2983bf435036ebfcf166d10b27 (patch) | |
| tree | d9cce66cf4d3eb4233193b50f7a6fc5f933d2fd8 /Documentation/conf.py | |
| parent | f9796b1f1a3edbf3b1838f7c4a47c8ef69e64e47 (diff) | |
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#customising-external-url-resolution
Change-Id: I9e1c76b2bacbacaa06340f940c76b50de38e43e8
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/84069
Reviewed-by: Nico Huber <nico.h@gmx.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation/conf.py')
| -rw-r--r-- | Documentation/conf.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index b0f2975dc7..6284fca73c 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -23,6 +23,7 @@ version = release.split("-")[0] 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'] |