diff options
Diffstat (limited to 'documentation/conf.py')
| -rw-r--r-- | documentation/conf.py | 77 |
1 files changed, 62 insertions, 15 deletions
diff --git a/documentation/conf.py b/documentation/conf.py index 34d1bc97a4..35c5c14535 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -1,6 +1,6 @@ # Configuration file for the Sphinx documentation builder. # -# SPDX-License-Identifier: CC-BY-2.0-UK +# SPDX-License-Identifier: CC-BY-SA-2.0-UK # # This file only contains a selection of the most common options. For a full # list see the documentation: @@ -15,8 +15,27 @@ import os import sys import datetime - -current_version = "dev" +try: + import yaml +except ImportError: + sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ + \nPlease make sure to install pyyaml Python package.\n") + sys.exit(1) + +# current_version = "dev" +# bitbake_version = "" # Leave empty for development branch +# Obtain versions from poky.yaml instead +with open("poky.yaml") as data: + buff = data.read() + subst_vars = yaml.safe_load(buff) + if "DOCCONF_VERSION" not in subst_vars: + sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml") + sys.exit(1) + current_version = subst_vars["DOCCONF_VERSION"] + if "BITBAKE_SERIES" not in subst_vars: + sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml") + sys.exit(1) + bitbake_version = subst_vars["BITBAKE_SERIES"] # String used in sidebar version = 'Version: ' + current_version @@ -27,12 +46,15 @@ release = current_version # -- Project information ----------------------------------------------------- -project = 'The Yocto Project' -copyright = '2010-%s, The Linux Foundation' % datetime.datetime.now().year +project = 'The Yocto Project \xae' +copyright = '2010-%s, The Linux Foundation, CC-BY-SA-2.0-UK license' % datetime.datetime.now().year author = 'The Linux Foundation' # -- General configuration --------------------------------------------------- +# Prevent building with an outdated version of sphinx +needs_sphinx = "4.0" + # to load local extension from the folder 'sphinx' sys.path.insert(0, os.path.abspath('sphinx')) @@ -53,8 +75,7 @@ templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst', - 'adt-manual/*.rst'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst'] # master document name. The default changed from contents to index. so better # set it ourselves. @@ -69,32 +90,49 @@ rst_prolog = """ # external links and substitutions extlinks = { - 'yocto_home': ('https://yoctoproject.org%s', None), - 'yocto_wiki': ('https://wiki.yoctoproject.org%s', None), + 'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'), + 'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'), + 'yocto_home': ('https://www.yoctoproject.org%s', None), + 'yocto_wiki': ('https://wiki.yoctoproject.org/wiki%s', None), 'yocto_dl': ('https://downloads.yoctoproject.org%s', None), 'yocto_lists': ('https://lists.yoctoproject.org%s', None), 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None), 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None), 'yocto_docs': ('https://docs.yoctoproject.org%s', None), 'yocto_git': ('https://git.yoctoproject.org%s', None), + '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': ('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), + 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), } -# Intersphinx config to use cross reference with Bitbake user manual +# Intersphinx config to use cross reference with BitBake user manual intersphinx_mapping = { - 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None) + 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) } +# Suppress "WARNING: unknown mimetype for ..." +suppress_warnings = ['epub.unknown_project_files'] + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' -html_theme_options = { - 'sticky_navigation': False, -} +try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_options = { + 'sticky_navigation': False, + } +except ImportError: + sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\ + \nPlease make sure to install the sphinx_rtd_theme Python package.\n") + sys.exit(1) html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' @@ -119,3 +157,12 @@ html_last_updated_fmt = '%b %d, %Y' # Remove the trailing 'dot' in section numbers html_secnumber_suffix = " " + +latex_elements = { + 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', + 'preamble': '\\setcounter{tocdepth}{2}', +} + +# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG +from sphinx.builders.epub3 import Epub3Builder +Epub3Builder.supported_image_types = ['image/png', 'image/gif', 'image/jpeg'] |