# MCUboot documentation build configuration file from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils MCUBOOT_BASE = utils.get_projdir("mcuboot") # General configuration -------------------------------------------------------- project = "MCUboot" copyright = "2019-2021" version = release = "1.7.99" sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "sphinx.ext.intersphinx", "recommonmark", "ncs_cache", "external_content" ] source_suffix = [".rst", ".md"] master_doc = "wrapper" linkcheck_ignore = [r"(\.\.(\\|/))+(kconfig|zephyr)"] # Options for HTML output ------------------------------------------------------
# TFM documentation build configuration file from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils TFM_BASE = utils.get_projdir("tfm") / "trusted-firmware-m" ZEPHYR_BASE = utils.get_projdir("zephyr") # General configuration -------------------------------------------------------- project = "Trusted Firmware-M" copyright = "2017-2019, ARM CE-OSS" author = "ARM CE-OSS" version = "1.3.99" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "m2r2", "sphinx.ext.autosectionlabel", "sphinxcontrib.plantuml", "ncs_cache", "zephyr.external_content",
# nrfxlib documentation build configuration file import os import re from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils ZEPHYR_BASE = utils.get_projdir("zephyr") NRFXLIB_BASE = utils.get_projdir("nrfxlib") # General configuration -------------------------------------------------------- project = "nrfxlib" copyright = "2019-2022, Nordic Semiconductor" author = "Nordic Semiconductor" version = release = "1.9.99" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "sphinx.ext.intersphinx", "breathe", "sphinxcontrib.mscgen",
# Zephyr documentation build configuration file import os from pathlib import Path import sys from sphinx.config import eval_config_file # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils ZEPHYR_BASE = utils.get_projdir("zephyr") # pylint: disable=undefined-variable,used-before-assignment # General ---------------------------------------------------------------------- # Import all Zephyr configuration, override as needed later os.environ["ZEPHYR_BASE"] = str(ZEPHYR_BASE) os.environ["ZEPHYR_BUILD"] = str(utils.get_builddir() / "zephyr") conf = eval_config_file(str(ZEPHYR_BASE / "doc" / "conf.py"), tags) locals().update(conf) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "sphinx.ext.intersphinx",
# TFM documentation build configuration file from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils TFM_BASE = utils.get_projdir("tfm") ZEPHYR_BASE = utils.get_projdir("zephyr") # General configuration -------------------------------------------------------- project = "Trusted Firmware-M" copyright = "2017-2019, ARM CE-OSS" author = "ARM CE-OSS" version = "1.5.0" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "m2r2", "sphinx.ext.autosectionlabel", "sphinxcontrib.plantuml", "sphinx_tabs.tabs",
# MCUboot documentation build configuration file from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils MCUBOOT_BASE = utils.get_projdir("mcuboot") ZEPHYR_BASE = utils.get_projdir("zephyr") # General configuration -------------------------------------------------------- project = "MCUboot" copyright = "2019-2022, Nordic Semiconductor" version = release = "1.8.99" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "zephyr.kconfig-role", "sphinx.ext.intersphinx", "recommonmark", "ncs_cache", "zephyr.external_content" ] source_suffix = [".rst", ".md"] master_doc = "wrapper"
# nrfx documentation build configuration file from pathlib import Path import sys import os from sphinx.config import eval_config_file # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils NRFX_BASE = utils.get_projdir("nrfx") / "nrfx" # pylint: disable=undefined-variable # General ---------------------------------------------------------------------- # Import nrfx configuration, override as needed later conf = eval_config_file(str(NRFX_BASE / "doc" / "sphinx" / "conf.py"), tags) locals().update(conf) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions.extend(["ncs_cache", "external_content", "doxyrunner"]) # Options for HTML output ------------------------------------------------------ html_static_path.append(str(NRF_BASE / "doc" / "_static")) html_theme_options = {"docsets": utils.get_docsets("nrfx")}
import sys import os from pathlib import Path from sphinx.config import eval_config_file # Paths ------------------------------------------------------------------------ BRIDLE_BASE = Path(__file__).absolute().parents[2] # Add the '_extensions' directory to sys.path, to enable finding Bridle's # utilities for Sphinx configuration within. sys.path.insert(0, os.path.join(BRIDLE_BASE, 'doc', '_utils')) import utils ZEPHYR_BASE = utils.get_projdir('zephyr') BRIDLE_ZEPHYR_BUILD = os.path.join(utils.get_builddir(), 'zephyr') # Add the '_extensions' directory to sys.path, to enable finding Bridle's # Sphinx extensions within. sys.path.insert(0, os.path.join(BRIDLE_BASE, 'doc', '_extensions')) # pylint: disable=undefined-variable # General ---------------------------------------------------------------------- # Import all Zephyr configuration, override as needed later conf = eval_config_file(os.path.join(ZEPHYR_BASE, 'doc', 'conf.py'), tags) locals().update(conf) # If your documentation needs a minimal Sphinx version, state it here.
# nrfx documentation build configuration file from pathlib import Path import sys import os from sphinx.config import eval_config_file # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils NRFX_BASE = utils.get_projdir("nrfx") / "nrfx" ZEPHYR_BASE = utils.get_projdir("zephyr") # pylint: disable=undefined-variable # General ---------------------------------------------------------------------- # Import nrfx configuration, override as needed later conf = eval_config_file(str(NRFX_BASE / "doc" / "sphinx" / "conf.py"), tags) locals().update(conf) sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions.extend( ["ncs_cache", "zephyr.external_content", "zephyr.doxyrunner"]) # Options for HTML output ------------------------------------------------------
from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils MATTER_BASE = utils.get_projdir("matter") ZEPHYR_BASE = utils.get_projdir("zephyr") # General configuration -------------------------------------------------------- project = "Matter" sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions")) sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "recommonmark", "sphinx_markdown_tables", "ncs_cache", "zephyr.external_content" ] source_suffix = [".rst", ".md"] # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [str(NRF_BASE / "doc" / "_static")] html_last_updated_fmt = "%b %d, %Y"
from pathlib import Path import sys # Paths ------------------------------------------------------------------------ NRF_BASE = Path(__file__).absolute().parents[2] sys.path.insert(0, str(NRF_BASE / "doc" / "_utils")) import utils MATTER_BASE = utils.get_projdir("matter") # General configuration -------------------------------------------------------- project = "Matter" sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = [ "recommonmark", "sphinx_markdown_tables", "ncs_cache", "external_content" ] source_suffix = [".rst", ".md"] # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [str(NRF_BASE / "doc" / "_static")]