blob: ebc26aa3bff0c00129510de5c622a070ea3b6e4d [file] [log] [blame]
Andrew Geisslerc9f78652020-09-18 14:11:35 -05001# Configuration file for the Sphinx documentation builder.
2#
Andrew Geisslerf0343792020-11-18 10:42:21 -06003# SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05004#
5# This file only contains a selection of the most common options. For a full
6# list see the documentation:
7# https://www.sphinx-doc.org/en/master/usage/configuration.html
8
9# -- Path setup --------------------------------------------------------------
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#
15import os
16import sys
17import datetime
18
19current_version = "dev"
20
21# String used in sidebar
22version = 'Version: ' + current_version
23if current_version == 'dev':
24 version = 'Version: Current Development'
25# Version seen in documentation_options.js and hence in js switchers code
26release = current_version
27
28
29# -- Project information -----------------------------------------------------
Andrew Geisslerc3d88e42020-10-02 09:45:00 -050030project = 'The Yocto Project \xae'
Andrew Geisslerc9f78652020-09-18 14:11:35 -050031copyright = '2010-%s, The Linux Foundation' % datetime.datetime.now().year
32author = 'The Linux Foundation'
33
34# -- General configuration ---------------------------------------------------
35
36# to load local extension from the folder 'sphinx'
37sys.path.insert(0, os.path.abspath('sphinx'))
38
39# Add any Sphinx extension module names here, as strings. They can be
40# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41# ones.
42extensions = [
43 'sphinx.ext.autosectionlabel',
44 'sphinx.ext.extlinks',
45 'sphinx.ext.intersphinx',
46 'yocto-vars'
47]
48autosectionlabel_prefix_document = True
49
50# Add any paths that contain templates here, relative to this directory.
51templates_path = ['_templates']
52
53# List of patterns, relative to source directory, that match files and
54# directories to ignore when looking for source files.
55# This pattern also affects html_static_path and html_extra_path.
56exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst',
57 'adt-manual/*.rst']
58
59# master document name. The default changed from contents to index. so better
60# set it ourselves.
61master_doc = 'index'
62
63# create substitution for project configuration variables
64rst_prolog = """
65.. |project_name| replace:: %s
66.. |copyright| replace:: %s
67.. |author| replace:: %s
68""" % (project, copyright, author)
69
70# external links and substitutions
71extlinks = {
72 'yocto_home': ('https://yoctoproject.org%s', None),
73 'yocto_wiki': ('https://wiki.yoctoproject.org%s', None),
74 'yocto_dl': ('https://downloads.yoctoproject.org%s', None),
75 'yocto_lists': ('https://lists.yoctoproject.org%s', None),
76 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
77 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
78 'yocto_docs': ('https://docs.yoctoproject.org%s', None),
79 'yocto_git': ('https://git.yoctoproject.org%s', None),
80 'oe_home': ('https://www.openembedded.org%s', None),
81 'oe_lists': ('https://lists.openembedded.org%s', None),
82}
83
84# Intersphinx config to use cross reference with Bitbake user manual
85intersphinx_mapping = {
86 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
87}
88
89# -- Options for HTML output -------------------------------------------------
90
91# The theme to use for HTML and HTML Help pages. See the documentation for
92# a list of builtin themes.
93#
Andrew Geisslerc3d88e42020-10-02 09:45:00 -050094try:
95 import sphinx_rtd_theme
96 html_theme = 'sphinx_rtd_theme'
97 html_theme_options = {
98 'sticky_navigation': False,
99 }
100except ImportError:
101 sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
102 \nPlease make sure to install the sphinx_rtd_theme python package.\n")
103 sys.exit(1)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500104
105html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
106
107# Add any paths that contain custom static files (such as style sheets) here,
108# relative to this directory. They are copied after the builtin static files,
109# so a file named "default.css" will overwrite the builtin "default.css".
110html_static_path = ['sphinx-static']
111
112html_context = {
113 'current_version': current_version,
114}
115
116# Add customm CSS and JS files
117html_css_files = ['theme_overrides.css']
118html_js_files = ['switchers.js']
119
120# Hide 'Created using Sphinx' text
121html_show_sphinx = False
122
123# Add 'Last updated' on each page
124html_last_updated_fmt = '%b %d, %Y'
125
126# Remove the trailing 'dot' in section numbers
127html_secnumber_suffix = " "