119 lines
4.2 KiB
Python
119 lines
4.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Belden CoreOS'
|
|
copyright = '2022, Belden CoreOS Team'
|
|
author = 'CoreOS Team'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
try:
|
|
git_describe = os.popen('git describe --tags --always').read().strip()
|
|
except all:
|
|
git_describe = ""
|
|
|
|
release = f'0.0.1 ({git_describe})'
|
|
version = release
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.extlinks',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.graphviz',
|
|
]
|
|
# 'sphinxcontrib.plantuml',
|
|
|
|
|
|
# external links and substitutions
|
|
extlinks = {
|
|
'cve': ('https://nvd.nist.gov/vuln/detail/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),
|
|
}
|
|
|
|
bitbake_version = "2.0"
|
|
yocto_version = "4.0.4"
|
|
|
|
# Intersphinx config to use cross reference with BitBake user manual
|
|
intersphinx_mapping = {
|
|
'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None),
|
|
'yocto': ('https://docs.yoctoproject.org/' + yocto_version, None),
|
|
'uefi': ('https://uefi.org/specs/UEFI/2.10/', None),
|
|
'ebbr': ('https://arm-software.github.io/ebbr/', None),
|
|
}
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
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', 'oe-workdir', 'oe-logs']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
try:
|
|
import sphinx_rtd_theme
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_theme_options = {
|
|
'sticky_navigation': False,
|
|
'collapse_navigation': False,
|
|
'display_version': True
|
|
}
|
|
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)
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
# Hide 'Created using Sphinx' text
|
|
html_show_sphinx = False
|
|
|
|
html_logo = "_static/logo.png"
|