mirror of
https://git.yoctoproject.org/meta-arm
synced 2026-07-16 15:57:19 +00:00
Hugues Kamba-Mpiana
74e7bcfcdf
Read the Docs recommends installing the Sphinx theme by listing it as an enabled extensions prior to setting it as the active theme. This commit adds it to the enabled extensions list as it was already set as the active theme. Signed-off-by: Hugues Kamba-Mpiana <hugues.kambampiana@arm.com> Signed-off-by: Jon Mason <jon.mason@arm.com>
68 lines
2.3 KiB
Python
68 lines
2.3 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.
|
|
#
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
import os
|
|
import sys
|
|
|
|
# Append the documentation directory to the path, so we can import variables
|
|
sys.path.append(os.path.dirname(__file__))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'corstone1000'
|
|
copyright = '2020-2024, Arm Limited'
|
|
author = 'Arm Limited'
|
|
|
|
|
|
# -- 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_rtd_theme',
|
|
]
|
|
|
|
# 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', 'docs/infra']
|
|
|
|
|
|
# -- 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'
|
|
|
|
# Define the canonical URL if you are using a custom domain on Read the Docs
|
|
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
|
|
|
|
# Tell Jinja2 templates the build is running on Read the Docs
|
|
if os.environ.get("READTHEDOCS", "") == "True":
|
|
if "html_context" not in globals():
|
|
html_context = {}
|
|
html_context["READTHEDOCS"] = True
|
|
|
|
|
|
# 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']
|