summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-09-07 12:52:49 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit18a484df634653f81d86bb5aa1a6ed7d44572f5a (patch)
tree4c103d91113c2c5d3de249f93ea44c80bfc9fb85 /documentation/conf.py
parent8f04fc58240fed4f17ef46302530320d0673379b (diff)
downloadpoky-18a484df634653f81d86bb5aa1a6ed7d44572f5a.tar.gz
sphinx: enable intersphinx extension
This extension can generate automatic links to the documentation of objects in other projects. We will use it to use cross references with the Bibtake manual, for example. (From yocto-docs rev: 5add9854b112f93acba982f237fbfa83aee80d77) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 54d8db4b47..546ca723a9 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -35,6 +35,7 @@ sys.path.insert(0, os.path.abspath('sphinx'))
35extensions = [ 35extensions = [
36 'sphinx.ext.autosectionlabel', 36 'sphinx.ext.autosectionlabel',
37 'sphinx.ext.extlinks', 37 'sphinx.ext.extlinks',
38 'sphinx.ext.intersphinx',
38 'yocto-vars' 39 'yocto-vars'
39] 40]
40autosectionlabel_prefix_document = True 41autosectionlabel_prefix_document = True
@@ -72,6 +73,11 @@ extlinks = {
72 'oe_lists': ('https://lists.openembedded.org%s', None), 73 'oe_lists': ('https://lists.openembedded.org%s', None),
73} 74}
74 75
76# Intersphinx config to use cross reference with Bitbake user manual
77intersphinx_mapping = {
78 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
79}
80
75# -- Options for HTML output ------------------------------------------------- 81# -- Options for HTML output -------------------------------------------------
76 82
77# The theme to use for HTML and HTML Help pages. See the documentation for 83# The theme to use for HTML and HTML Help pages. See the documentation for