summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py25
1 files changed, 25 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index dd20e44a1a..5519acb87a 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -26,10 +26,15 @@ author = 'The Linux Foundation'
26 26
27# -- General configuration --------------------------------------------------- 27# -- General configuration ---------------------------------------------------
28 28
29# to load local extension from the folder 'sphinx'
30sys.path.insert(0, os.path.abspath('sphinx'))
31
29# Add any Sphinx extension module names here, as strings. They can be 32# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 33# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones. 34# ones.
32extensions = [ 35extensions = [
36 'sphinx.ext.extlinks',
37 'yocto-vars'
33] 38]
34 39
35# Add any paths that contain templates here, relative to this directory. 40# Add any paths that contain templates here, relative to this directory.
@@ -44,6 +49,26 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
44# set it ourselves. 49# set it ourselves.
45master_doc = 'index' 50master_doc = 'index'
46 51
52# create substitution for project configuration variables
53rst_prolog = """
54.. |project_name| replace:: %s
55.. |copyright| replace:: %s
56.. |author| replace:: %s
57""" % (project, copyright, author)
58
59# external links and substitutions
60extlinks = {
61 'yocto_home': ('https://yoctoproject.org%s', None),
62 'yocto_wiki': ('https://wiki.yoctoproject.org%s', None),
63 'yocto_dl': ('https://downloads.yoctoproject.org%s', None),
64 'yocto_lists': ('https://lists.yoctoproject.org%s', None),
65 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
66 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
67 'yocto_git': ('https://git.yoctoproject.org%s', None),
68 'oe_home': ('https://www.openembedded.org%s', None),
69 'oe_lists': ('https://lists.openembedded.org%s', None),
70}
71
47# -- Options for HTML output ------------------------------------------------- 72# -- Options for HTML output -------------------------------------------------
48 73
49# The theme to use for HTML and HTML Help pages. See the documentation for 74# The theme to use for HTML and HTML Help pages. See the documentation for