summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-31 17:04:45 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-04-03 16:29:51 +0100
commit6b2bc1e4cb69f3d1567e99a75db3fdbd2cfe942e (patch)
tree392759ae102cb3a9ff45fce4f6d9bdc76dcef699 /documentation/conf.py
parent5ec826fa2ec4ae7e898eaf2d974d1467c1dadaef (diff)
downloadpoky-6b2bc1e4cb69f3d1567e99a75db3fdbd2cfe942e.tar.gz
documentation/conf.py: define a manpage url
By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0d0115cb2d96960837678f775cf5c2297494c51c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 477e75112a..2aceeb8e79 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -111,6 +111,9 @@ extlinks = {
111 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), 111 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None),
112} 112}
113 113
114# To be able to use :manpage:`<something>` in the docs.
115manpages_url = 'https://manpages.debian.org/{path}'
116
114# Intersphinx config to use cross reference with BitBake user manual 117# Intersphinx config to use cross reference with BitBake user manual
115intersphinx_mapping = { 118intersphinx_mapping = {
116 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) 119 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)