exclude_patterns = ["readme.rst"] # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [ str(NRF_BASE / "doc" / "_static"), str(TFM_BASE / "docs" / "_static"), ] html_last_updated_fmt = None html_show_sourcelink = True html_show_sphinx = False html_show_copyright = False html_theme_options = {"docsets": utils.get_docsets("tfm")} # Options for autosectionlabel ------------------------------------------------- autosectionlabel_prefix_document = True autosectionlabel_maxdepth = 2 # Options for external_content ------------------------------------------------- external_content_contents = [ (TFM_BASE / "docs", "index.rst"), (TFM_BASE, "docs/**/*"), (TFM_BASE, "platform/**/*"), (TFM_BASE, "tools/**/*"), ]
"sphinx.ext.intersphinx", "recommonmark", "ncs_cache", "external_content" ] source_suffix = [".rst", ".md"] master_doc = "wrapper" linkcheck_ignore = [r"(\.\.(\\|/))+(kconfig|zephyr)"] # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [str(NRF_BASE / "doc" / "_static")] html_last_updated_fmt = "%b %d, %Y" html_show_sourcelink = True html_show_sphinx = False html_theme_options = {"docsets": utils.get_docsets("mcuboot")} # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() kconfig_mapping = utils.get_intersphinx_mapping("kconfig") if kconfig_mapping: intersphinx_mapping["kconfig"] = kconfig_mapping # Options for external_content ------------------------------------------------- external_content_contents = [ (NRF_BASE / "doc" / "mcuboot", "*.rst"), (MCUBOOT_BASE / "docs", "*.md"), ]
linkcheck_ignore = [r"(\.\.(\\|/))+(kconfig|nrf)"] rst_epilog = """ .. include:: /doc/links.txt .. include:: /doc/shortcuts.txt """ # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [str(NRF_BASE / "doc" / "_static")] html_last_updated_fmt = "%b %d, %Y" html_show_sourcelink = True html_show_sphinx = False html_theme_options = {"docsets": utils.get_docsets("nrfxlib")} # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() kconfig_mapping = utils.get_intersphinx_mapping("kconfig") if kconfig_mapping: intersphinx_mapping["kconfig"] = kconfig_mapping nrf_mapping = utils.get_intersphinx_mapping("nrf") if nrf_mapping: intersphinx_mapping["nrf"] = nrf_mapping # -- Options for doxyrunner plugin ---------------------------------------------
author = "Nordic Semiconductor" # NOTE: use blank space as version to preserve space version = " " sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions")) extensions = ["ncs_cache"] # Options for HTML output ------------------------------------------------------ html_theme = "sphinx_ncs_theme" html_static_path = [str(NRF_BASE / "doc" / "_static")] html_title = project html_last_updated_fmt = "%b %d, %Y" html_show_sourcelink = True html_show_sphinx = False html_theme_options = {"docsets": utils.get_docsets("kconfig")} # Options for ncs_cache -------------------------------------------------------- ncs_cache_docset = "kconfig" ncs_cache_build_dir = utils.get_builddir() ncs_cache_config = NRF_BASE / "doc" / "cache.yml" ncs_cache_manifest = NRF_BASE / "west.yml" def setup(app): app.add_css_file("css/common.css") app.add_css_file("css/kconfig.css")
html_theme = "sphinx_ncs_theme" html_theme_path = [] html_favicon = None html_static_path.append(str(NRF_BASE / "doc" / "_static")) html_last_updated_fmt = "%b %d, %Y" html_show_sourcelink = True html_logo = None html_context = { "show_license": True, "docs_title": docs_title, "is_release": is_release, } html_theme_options = {"docsets": utils.get_docsets("zephyr")} # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() kconfig_mapping = utils.get_intersphinx_mapping("kconfig") if kconfig_mapping: intersphinx_mapping["kconfig"] = kconfig_mapping # -- Options for zephyr.warnings_filter ---------------------------------------- warnings_filter_silent = True # Options for ncs_cache --------------------------------------------------------
# If true, license is shown in the HTML footer. Default is True. html_show_license = True # If given, this must be the name of an image file that is the logo of the # docs, or URL that points an image file for the logo. html_logo = None html_context = { 'show_license': html_show_license, 'docs_title': docs_title, 'is_release': is_release, } html_theme_options = { 'docsets': utils.get_docsets('zephyr'), 'default_docset': utils.get_default_docset(), } # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() kconfig_mapping = utils.get_intersphinx_mapping('kconfig') if kconfig_mapping: intersphinx_mapping['kconfig'] = kconfig_mapping devicetree_mapping = utils.get_intersphinx_mapping('devicetree') if devicetree_mapping: intersphinx_mapping['devicetree'] = devicetree_mapping
html_split_index = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True # If true, license is shown in the HTML footer. Default is True. html_show_license = True html_theme_options = { 'docsets': utils.get_docsets('devicetree'), 'default_docset': utils.get_default_docset(), } # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() zephyr_mapping = utils.get_intersphinx_mapping('zephyr') if zephyr_mapping: intersphinx_mapping['zephyr'] = zephyr_mapping # Options for zephyr.external_content ------------------------------------------ external_content_directives = ( 'figure',
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" html_show_sourcelink = True html_show_sphinx = False html_theme_options = {"docsets": utils.get_docsets("matter")} # Options for external_content ------------------------------------------------- external_content_contents = [ (NRF_BASE / "doc" / "matter", "*.rst"), (MATTER_BASE / "docs" / "guides", "images"), (MATTER_BASE / "docs" / "guides", "nrfconnect_*.md"), (MATTER_BASE / "docs" / "guides", "openthread_*.md"), (MATTER_BASE / "docs" / "guides", "python_*.md"), (MATTER_BASE / "docs" / "guides", "android_*.md"), (MATTER_BASE / "docs" / "guides", "BUILDING.md"), (MATTER_BASE / "docs" / "guides", "chip_tool_guide.md"), (MATTER_BASE / "docs" / "guides", "access-control-guide.md"), ]
html_split_index = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True # If true, license is shown in the HTML footer. Default is True. html_show_license = True html_theme_options = { 'docsets': utils.get_docsets('bridle'), 'default_docset': utils.get_default_docset(), } # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() zephyr_mapping = utils.get_intersphinx_mapping('zephyr') if zephyr_mapping: intersphinx_mapping['zephyr'] = zephyr_mapping kconfig_mapping = utils.get_intersphinx_mapping('kconfig') if kconfig_mapping: intersphinx_mapping['kconfig'] = kconfig_mapping
html_split_index = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True # If true, license is shown in the HTML footer. Default is True. html_show_license = True html_theme_options = { 'docsets': utils.get_docsets('kconfig'), 'default_docset': utils.get_default_docset(), } # Options for intersphinx ------------------------------------------------------ intersphinx_mapping = dict() zephyr_mapping = utils.get_intersphinx_mapping('zephyr') if zephyr_mapping: intersphinx_mapping['zephyr'] = zephyr_mapping # Options for zephyr.external_content ------------------------------------------ external_content_directives = ( 'figure',