diff mbox series

[01/18] conf.py: define new *_path roles

Message ID 20260410-second-release-notes-6-0-v1-1-40213436c3ca@bootlin.com
State New
Headers show
Series Updates for upcoming Wrynose release | expand

Commit Message

Antonin Godard April 10, 2026, 2:43 p.m. UTC
Defines three new bitbake_path, meta_yocto_path, and oecore_path roles
that can be used to quickly reference a file or directory in one of
those repositories and link to our web interface for the path, e.g.
:oecore_path:`meta/conf/bitbake.conf`.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/conf.py | 3 +++
 1 file changed, 3 insertions(+)
diff mbox series

Patch

diff --git a/documentation/conf.py b/documentation/conf.py
index e5e3a8a89..58c6406f1 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -101,6 +101,7 @@  meta_yocto_git = f"{yocto_git_server}/meta-yocto"
 # external links and substitutions
 extlinks = {
     'bitbake_git': (f'{bitbake_git}%s', None),
+    'bitbake_path': (f'{bitbake_git}/tree/%s', '%s'),
     'bitbake_rev': (f'{bitbake_git}/commit/?id=%s', '%.7s'),
     'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'),
     'cve_nist': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'),
@@ -112,11 +113,13 @@  extlinks = {
     'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
     'yocto_docs': ('https://docs.yoctoproject.org%s', None),
     'yocto_git': (f'{yocto_git_server}%s', None),
+    'meta_yocto_path': (f'{meta_yocto_git}/tree/%s', '%s'),
     'meta_yocto_rev': (f'{meta_yocto_git}/commit/?id=%s', '%.7s'),
     'yocto_sstate': ('http://sstate.yoctoproject.org%s', None),
     'oe_home': ('https://www.openembedded.org%s', None),
     'oe_lists': ('https://lists.openembedded.org%s', None),
     'oe_git': (f'{oe_git_server}%s', None),
+    'oecore_path': (f'{oecore_git}/tree/%s', '%s'),
     'oecore_rev': (f'{oecore_git}/commit/?id=%s', '%.7s'),
     'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
     'oe_layerindex': ('https://layers.openembedded.org%s', None),