doc: bitbake-user-manual: conf.py: add more extlinks

Message ID 20211215162227.2001656-1-michael.opdenacker@bootlin.com
State New
Headers show
Series doc: bitbake-user-manual: conf.py: add more extlinks | expand

Commit Message

Michael Opdenacker Dec. 15, 2021, 4:22 p.m. UTC
Useful in particular to refer to files in git repositories

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 doc/conf.py | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Quentin Schulz Jan. 3, 2022, 9:17 a.m. UTC | #1
Hi Michael,

Could we have the new entries alphabetically sorted? i.e. oe_git first 
in the list of oe extlinks and oe_wiki last?

Also, is there any plan of using those new extlinks? I only see one 
patch in this thread, hence the question.

Cheers,
Quentin
Michael Opdenacker Jan. 4, 2022, 7:15 p.m. UTC | #2
Hi Quentin

Thanks for the review.

On 1/3/22 10:17 AM, Quentin Schulz wrote:
> Hi Michael,
>
> Could we have the new entries alphabetically sorted? i.e. oe_git first
> in the list of oe extlinks and oe_wiki last?

Sure, this makes sense.
>
> Also, is there any plan of using those new extlinks? I only see one
> patch in this thread, hence the question.


Well, my first need was to use the "oe_git" macro to provide links to
source code, for example for bitbake-hashserv.
Thinking this over, I realize it probably makes sense to just add the
macros when I actually need them.
I'll just to that.
Cheers
Michael.

Patch

diff --git a/doc/conf.py b/doc/conf.py
index fc2ee081..b2369e82 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -36,7 +36,13 @@  author = 'Richard Purdie, Chris Larson, and Phil Blundell'
 # external links and substitutions
 extlinks = {
     'yocto_docs': ('https://docs.yoctoproject.org%s', None),
+    'yocto_git': ('https://git.yoctoproject.org/cgit/cgit.cgi%s', None),
+    'oe_home': ('https://www.openembedded.org%s', None),
     'oe_lists': ('https://lists.openembedded.org%s', None),
+    'oe_git': ('https://git.openembedded.org%s', None),
+    'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
+    'oe_layerindex': ('https://layers.openembedded.org%s', None),
+    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
 }
 
 # -- General configuration ---------------------------------------------------