diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-03-31 17:04:45 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2025-04-28 08:18:53 -0700 |
commit | 5d81e92acdc4aecfe513c7e59a980dc6c7511f52 (patch) | |
tree | 24ec80f02e3ccbc5d4bfe947c2bafeb7bbf9f9ef /documentation/conf.py | |
parent | cb1da2f8257e8df1eeb036ccf186c38780bc50ca (diff) | |
download | poky-5d81e92acdc4aecfe513c7e59a980dc6c7511f52.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: 73faf4a4fdd3d536e8af92b49bf067746cd9fa05)
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: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r-- | documentation/conf.py | 3 |
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. | ||
115 | manpages_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 |
115 | intersphinx_mapping = { | 118 | intersphinx_mapping = { |
116 | 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) | 119 | 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) |