| # -*- coding: utf-8 -*- |
| # |
| # Zephyr documentation build configuration file, created by |
| # sphinx-quickstart on Fri May 8 11:43:01 2015. |
| # |
| # This file is execfile()d with the current directory set to its |
| # containing dir. |
| # |
| # Note that not all possible configuration values are present in this |
| # autogenerated file. |
| # |
| # All configuration values have a default; values that are commented out |
| # serve to show the default. |
| |
| import sys |
| import os |
| |
| if "ZEPHYR_BASE" not in os.environ: |
| sys.exit("$ZEPHYR_BASE environment variable undefined.") |
| ZEPHYR_BASE = os.path.abspath(os.environ["ZEPHYR_BASE"]) |
| |
| if "ZEPHYR_BUILD" not in os.environ: |
| sys.exit("$ZEPHYR_BUILD environment variable undefined.") |
| ZEPHYR_BUILD = os.path.abspath(os.environ["ZEPHYR_BUILD"]) |
| |
| # Add the 'extensions' directory to sys.path, to enable finding Sphinx |
| # extensions within. |
| sys.path.insert(0, os.path.join(ZEPHYR_BASE, 'doc', 'extensions')) |
| |
| # Add the directory which contains the runners package as well, |
| # for autodoc directives on runners.xyz. |
| sys.path.insert(0, os.path.join(ZEPHYR_BASE, 'scripts', 'west_commands')) |
| |
| try: |
| import west as west_found |
| except ImportError: |
| west_found = False |
| |
| # -- General configuration ------------------------------------------------ |
| |
| # If your documentation needs a minimal Sphinx version, state it here. |
| #needs_sphinx = '1.0' |
| |
| # Add any Sphinx extension module names here, as strings. They can be |
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| # ones. |
| extensions = [ |
| 'breathe', 'sphinx.ext.todo', |
| 'sphinx.ext.extlinks', |
| 'sphinx.ext.autodoc', |
| 'zephyr.application', |
| 'zephyr.html_redirects', |
| 'only.eager_only', |
| 'zephyr.link-roles', |
| 'sphinx_tabs.tabs' |
| ] |
| |
| # Only use SVG converter when it is really needed, e.g. LaTeX. |
| if tags.has("svgconvert"): # pylint: disable=undefined-variable |
| extensions.append('sphinxcontrib.rsvgconverter') |
| |
| # Add any paths that contain templates here, relative to this directory. |
| templates_path = ['_templates'] |
| |
| # The suffix(es) of source filenames. |
| # You can specify multiple suffix as a list of string: |
| # source_suffix = ['.rst', '.md'] |
| source_suffix = '.rst' |
| |
| # The encoding of source files. |
| #source_encoding = 'utf-8-sig' |
| |
| # The master toctree document. |
| master_doc = 'index' |
| |
| # General information about the project. |
| project = u'Zephyr Project' |
| copyright = u'2015-2020 Zephyr Project members and individual contributors' |
| author = u'The Zephyr Project' |
| |
| # The following code tries to extract the information by reading the Makefile, |
| # when Sphinx is run directly (e.g. by Read the Docs). |
| try: |
| version_major = None |
| version_minor = None |
| patchlevel = None |
| extraversion = None |
| for line in open(os.path.join(ZEPHYR_BASE, 'VERSION')): |
| key, val = [x.strip() for x in line.split('=', 2)] |
| if key == 'VERSION_MAJOR': |
| version_major = val |
| if key == 'VERSION_MINOR': |
| version_minor = val |
| elif key == 'PATCHLEVEL': |
| patchlevel = val |
| elif key == 'EXTRAVERSION': |
| extraversion = val |
| if version_major and version_minor and patchlevel and extraversion: |
| break |
| except Exception: |
| pass |
| finally: |
| if version_major and version_minor and patchlevel and extraversion is not None: |
| version = release = version_major + '.' + version_minor + '.' + patchlevel |
| if extraversion != '': |
| version = release = version + '-' + extraversion |
| else: |
| sys.stderr.write('Warning: Could not extract kernel version\n') |
| version = release = "unknown version" |
| |
| # The language for content autogenerated by Sphinx. Refer to documentation |
| # for a list of supported languages. |
| # |
| # This is also used if you do content translation via gettext catalogs. |
| # Usually you set "language" from the command line for these cases. |
| language = None |
| |
| # There are two options for replacing |today|: either, you set today to some |
| # non-false value, then it is used: |
| #today = '' |
| # Else, today_fmt is used as the format for a strftime call. |
| #today_fmt = '%B %d, %Y' |
| |
| # List of patterns, relative to source directory, that match files and |
| # directories to ignore when looking for source files. |
| exclude_patterns = ['_build'] |
| if not west_found: |
| exclude_patterns.append('**/*west-apis*') |
| else: |
| exclude_patterns.append('**/*west-not-found*') |
| |
| # The reST default role (used for this markup: `text`) to use for all |
| # documents. |
| |
| # This change will allow us to use bare back-tick notation to let |
| # Sphinx hunt for a reference, starting with normal "document" |
| # references such as :ref:, but also including :c: and :cpp: domains |
| # (potentially) helping with API (doxygen) references simply by using |
| # `name` |
| |
| default_role = 'any' |
| # default_domain = 'cpp' |
| |
| # If true, '()' will be appended to :func: etc. cross-reference text. |
| #add_function_parentheses = True |
| |
| # If true, the current module name will be prepended to all description |
| # unit titles (such as .. function::). |
| #add_module_names = True |
| |
| # If true, sectionauthor and moduleauthor directives will be shown in the |
| # output. They are ignored by default. |
| #show_authors = False |
| |
| # The name of the Pygments (syntax highlighting) style to use. |
| pygments_style = 'sphinx' |
| |
| # Additional lexer for Pygments (syntax highlighting) |
| from lexer.DtsLexer import DtsLexer |
| from sphinx.highlighting import lexers |
| lexers['DTS'] = DtsLexer() |
| |
| # A list of ignored prefixes for module index sorting. |
| #modindex_common_prefix = [] |
| |
| # If true, keep warnings as "system message" paragraphs in the built documents. |
| #keep_warnings = False |
| |
| # If true, `todo` and `todoList` produce output, else they produce nothing. |
| todo_include_todos = False |
| |
| rst_epilog = """ |
| .. include:: /substitutions.txt |
| """ |
| |
| # -- Options for HTML output ---------------------------------------------- |
| |
| import sphinx_rtd_theme |
| html_theme = "sphinx_rtd_theme" |
| html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| html_theme_options = { |
| 'prev_next_buttons_location': None |
| } |
| |
| if tags.has('release'): # pylint: disable=undefined-variable |
| is_release = True |
| docs_title = 'Docs / %s' %(version) |
| else: |
| is_release = False |
| docs_title = 'Docs / Latest' |
| |
| # The name for this set of Sphinx documents. If None, it defaults to |
| # "<project> v<release> documentation". |
| html_title = "Zephyr Project Documentation" |
| |
| # This value determines the text for the permalink; it defaults to "ΒΆ". |
| # Set it to None or the empty string to disable permalinks. |
| #html_add_permalinks = "" |
| |
| # A shorter title for the navigation bar. Default is the same as html_title. |
| #html_short_title = None |
| |
| # The name of an image file (relative to this directory) to place at the top |
| # of the sidebar. |
| html_logo = 'images/Zephyr-Kite-logo.png' |
| |
| # The name of an image file (within the static path) to use as favicon of the |
| # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
| # pixels large. |
| html_favicon = 'images/zp_favicon.png' |
| |
| # 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 = ['{}/doc/static'.format(ZEPHYR_BASE)] |
| |
| # Add any extra paths that contain custom files (such as robots.txt or |
| # .htaccess) here, relative to this directory. These files are copied |
| # directly to the root of the documentation. |
| #html_extra_path = [] |
| |
| # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| # using the given strftime format. |
| html_last_updated_fmt = '%b %d, %Y' |
| |
| # If true, SmartyPants will be used to convert quotes and dashes to |
| # typographically correct entities. |
| #html_use_smartypants = |
| |
| # Custom sidebar templates, maps document names to template names. |
| #html_sidebars = {} |
| |
| # Additional templates that should be rendered to pages, maps page names to |
| # template names. |
| #html_additional_pages = {} |
| |
| # If false, no module index is generated. |
| html_domain_indices = False |
| |
| # If false, no index is generated. |
| html_use_index = True |
| |
| # If true, the index is split into individual pages for each letter. |
| html_split_index = True |
| |
| # If true, links to the reST sources are added to the pages. |
| html_show_sourcelink = False |
| |
| # 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 = tags.has('development') |
| |
| # If true, license is shown in the HTML footer. Default is True. |
| html_show_license = True |
| |
| # If true, an OpenSearch description file will be output, and all pages will |
| # contain a <link> tag referring to it. The value of this option must be the |
| # base URL from which the finished HTML is served. |
| #html_use_opensearch = '' |
| |
| # This is the file name suffix for HTML files (e.g. ".xhtml"). |
| #html_file_suffix = None |
| |
| # Language to be used for generating the HTML full-text search index. |
| # Sphinx supports the following languages: |
| # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
| # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
| #html_search_language = 'en' |
| |
| sourcelink_suffix = '.txt' |
| |
| # A dictionary with options for the search language support, empty by default. |
| # Now only 'ja' uses this config value |
| #html_search_options = {'type': 'default'} |
| |
| # The name of a javascript file (relative to the configuration directory) that |
| # implements a search results scorer. If empty, the default will be used. |
| html_search_scorer = 'scorer.js' |
| |
| # Output file base name for HTML help builder. |
| htmlhelp_basename = 'zephyrdoc' |
| |
| |
| # Custom added feature to allow redirecting old URLs (caused by |
| # reorganizing doc directories) |
| # |
| # list of tuples (old_url, new_url) for pages to redirect |
| # |
| # URLs must be relative to document root (with NO leading slash), |
| # and without the html extension) |
| html_redirect_pages = [ |
| ('contribute/contribute_guidelines', 'contribute/index'), |
| ('application/application', 'application/index.rst'), |
| ('security/security', 'security/index'), |
| ('boards/boards', 'boards/index'), |
| ('samples/samples', 'samples/index'), |
| ('releases/release-notes', 'releases/index'), |
| ('getting_started/getting_started', 'getting_started/index'), |
| ('introduction/introducing_zephyr', 'introduction/index'), |
| ('api/index', 'reference/index'), |
| ('api/api', 'reference/index'), |
| ('subsystems/subsystems', 'reference/index'), |
| ('kernel/kernel', 'reference/kernel/index'), |
| ('boards/arc/em_starterkit/doc/board', 'boards/arc/em_starterkit/doc/index'), |
| ('boards/arc/nsim_em/doc/board', 'boards/arc/nsim_em/doc/index'), |
| ('boards/arm/96b_argonkey/doc/96b_argonkey', 'boards/arm/96b_argonkey/doc/index'), |
| ('boards/arm/96b_carbon/doc/96b_carbon', 'boards/arm/96b_carbon/doc/index'), |
| ('boards/arm/96b_carbon_nrf51/doc/96b_carbon_nrf51', 'boards/arm/96b_carbon_nrf51/doc/index'), |
| ('boards/arm/96b_neonkey/doc/96b_neonkey', 'boards/arm/96b_neonkey/doc/index'), |
| ('boards/arm/96b_nitrogen/doc/96b_nitrogen', 'boards/arm/96b_nitrogen/doc/index'), |
| ('boards/arm/adafruit_feather_m0_basic_proto/doc/adafruit_feather_m0_basic_proto', 'boards/arm/adafruit_feather_m0_basic_proto/doc/index'), |
| ('boards/arm/adafruit_trinket_m0/doc/adafruit_trinket_m0', 'boards/arm/adafruit_trinket_m0/doc/index'), |
| ('boards/arm/arduino_due/doc/board', 'boards/arm/arduino_due/doc/index'), |
| ('boards/arm/arduino_zero/doc/arduino_zero', 'boards/arm/arduino_zero/doc/index'), |
| ('boards/arm/atsamd20_xpro/doc/atsamd20_xpro', 'boards/arm/atsamd20_xpro/doc/index'), |
| ('boards/arm/bbc_microbit/doc/board', 'boards/arm/bbc_microbit/doc/index'), |
| ('boards/arm/cc3220sf_launchxl/doc/cc3220sf_launchxl', 'boards/arm/cc3220sf_launchxl/doc/index'), |
| ('boards/arm/colibri_imx7d_m4/doc/colibri_imx7d_m4', 'boards/arm/colibri_imx7d_m4/doc/index'), |
| ('boards/arm/disco_l475_iot1/doc/disco_l475_iot1', 'boards/arm/disco_l475_iot1/doc/index'), |
| ('boards/arm/dragino_lsn50/doc/dragino_lsn50', 'boards/arm/dragino_lsn50/doc/index'), |
| ('boards/arm/efm32wg_stk3800/doc/efm32wg_stk3800', 'boards/arm/efm32wg_stk3800/doc/index'), |
| ('boards/arm/efr32_slwstk6061a/doc/efr32_slwstk6061a', 'boards/arm/efr32_slwstk6061a/doc/index'), |
| ('boards/arm/frdm_k64f/doc/frdm_k64f', 'boards/arm/frdm_k64f/doc/index'), |
| ('boards/arm/frdm_kl25z/doc/frdm_kl25z', 'boards/arm/frdm_kl25z/doc/index'), |
| ('boards/arm/frdm_kw41z/doc/frdm_kw41z', 'boards/arm/frdm_kw41z/doc/index'), |
| ('boards/arm/hexiwear_k64/doc/hexiwear_k64', 'boards/arm/hexiwear_k64/doc/index'), |
| ('boards/arm/hexiwear_kw40z/doc/hexiwear_kw40z', 'boards/arm/hexiwear_kw40z/doc/index'), |
| ('boards/arm/lpcxpresso54114_m0/doc/lpcxpresso54114_m0', 'boards/arm/lpcxpresso54114_m0/doc/index'), |
| ('boards/arm/lpcxpresso54114_m4/doc/lpcxpresso54114', 'boards/arm/lpcxpresso54114_m4/doc/index'), |
| ('boards/arm/mimxrt1020_evk/doc/mimxrt1020_evk', 'boards/arm/mimxrt1020_evk/doc/index'), |
| ('boards/arm/mimxrt1050_evk/doc/mimxrt1050_evk', 'boards/arm/mimxrt1050_evk/doc/index'), |
| ('boards/arm/mimxrt1060_evk/doc/mimxrt1060_evk', 'boards/arm/mimxrt1060_evk/doc/index'), |
| ('boards/arm/mimxrt1064_evk/doc/mimxrt1064_evk', 'boards/arm/mimxrt1064_evk/doc/index'), |
| ('boards/arm/mps2_an385/doc/mps2_an385', 'boards/arm/mps2_an385/doc/index'), |
| ('boards/arm/msp_exp432p401r_launchxl/doc/msp_exp432p401r_launchxl', 'boards/arm/msp_exp432p401r_launchxl/doc/index'), |
| ('boards/arm/nrf51_ble400/doc/nrf51_ble400', 'boards/arm/nrf51_ble400/doc/index'), |
| ('boards/arm/nrf51_blenano/doc/nrf51_blenano', 'boards/arm/nrf51_blenano/doc/index'), |
| ('boards/arm/nrf51_pca10028/doc/nrf51_pca10028', 'boards/arm/nrf51_pca10028/doc/index'), |
| ('boards/arm/nrf51_vbluno51/doc/nrf51_vbluno51', 'boards/arm/nrf51_vbluno51/doc/index'), |
| ('boards/arm/nrf52810_pca10040/doc/nrf52810_pca10040', 'boards/arm/nrf52810_pca10040/doc/index'), |
| ('boards/arm/nrf52840_pca10056/doc/nrf52840_pca10056', 'boards/arm/nrf52840_pca10056/doc/index'), |
| ('boards/arm/nrf52840_pca10059/doc/nrf52840_pca10059', 'boards/arm/nrf52840_pca10059/doc/index'), |
| ('boards/arm/nrf52_adafruit_feather/doc/nrf52_adafruit_feather', 'boards/arm/nrf52_adafruit_feather/doc/index'), |
| ('boards/arm/nrf52_blenano2/doc/nrf52_blenano2', 'boards/arm/nrf52_blenano2/doc/index'), |
| ('boards/arm/nrf52_pca10040/doc/nrf52_pca10040', 'boards/arm/nrf52_pca10040/doc/index'), |
| ('boards/arm/nrf52_pca20020/doc/nrf52_pca20020', 'boards/arm/nrf52_pca20020/doc/index'), |
| ('boards/arm/nrf52_vbluno52/doc/nrf52_vbluno52', 'boards/arm/nrf52_vbluno52/doc/index'), |
| ('boards/arm/nucleo_f030r8/doc/nucleof030r8', 'boards/arm/nucleo_f030r8/doc/index'), |
| ('boards/arm/nucleo_f070rb/doc/nucleof070rb', 'boards/arm/nucleo_f070rb/doc/index'), |
| ('boards/arm/nucleo_f091rc/doc/nucleof091rc', 'boards/arm/nucleo_f091rc/doc/index'), |
| ('boards/arm/nucleo_f103rb/doc/nucleof103rb', 'boards/arm/nucleo_f103rb/doc/index'), |
| ('boards/arm/nucleo_f207zg/doc/nucleo_f207zg', 'boards/arm/nucleo_f207zg/doc/index'), |
| ('boards/arm/nucleo_f334r8/doc/nucleof334r8', 'boards/arm/nucleo_f334r8/doc/index'), |
| ('boards/arm/nucleo_f401re/doc/nucleof401re', 'boards/arm/nucleo_f401re/doc/index'), |
| ('boards/arm/nucleo_f411re/doc/nucleof411re', 'boards/arm/nucleo_f411re/doc/index'), |
| ('boards/arm/nucleo_f412zg/doc/nucleof412zg', 'boards/arm/nucleo_f412zg/doc/index'), |
| ('boards/arm/nucleo_f413zh/doc/nucleof413zh', 'boards/arm/nucleo_f413zh/doc/index'), |
| ('boards/arm/nucleo_f429zi/doc/nucleof429zi', 'boards/arm/nucleo_f429zi/doc/index'), |
| ('boards/arm/nucleo_f446re/doc/nucleof446re', 'boards/arm/nucleo_f446re/doc/index'), |
| ('boards/arm/nucleo_l053r8/doc/nucleol053r8', 'boards/arm/nucleo_l053r8/doc/index'), |
| ('boards/arm/nucleo_l073rz/doc/nucleol073rz', 'boards/arm/nucleo_l073rz/doc/index'), |
| ('boards/arm/nucleo_l432kc/doc/nucleol432kc', 'boards/arm/nucleo_l432kc/doc/index'), |
| ('boards/arm/nucleo_l476rg/doc/nucleol476rg', 'boards/arm/nucleo_l476rg/doc/index'), |
| ('boards/arm/olimex_stm32_e407/doc/olimex_stm32_e407', 'boards/arm/olimex_stm32_e407/doc/index'), |
| ('boards/arm/olimex_stm32_h407/doc/olimex_stm32_h407', 'boards/arm/olimex_stm32_h407/doc/index'), |
| ('boards/arm/olimex_stm32_p405/doc/olimex_stm32_p405', 'boards/arm/olimex_stm32_p405/doc/index'), |
| ('boards/arm/olimexino_stm32/doc/olimexino_stm32', 'boards/arm/olimexino_stm32/doc/index'), |
| ('boards/arm/qemu_cortex_m3/doc/board', 'boards/arm/qemu_cortex_m3/doc/index'), |
| ('boards/arm/reel_board/doc/reel_board', 'boards/arm/reel_board/doc/index'), |
| ('boards/arm/sam4s_xplained/doc/sam4s_xplained', 'boards/arm/sam4s_xplained/doc/index'), |
| ('boards/arm/sam_e70_xplained/doc/sam_e70_xplained', 'boards/arm/sam_e70_xplained/doc/index'), |
| ('boards/arm/stm3210c_eval/doc/stm3210c_eval', 'boards/arm/stm3210c_eval/doc/index'), |
| ('boards/arm/stm32373c_eval/doc/stm32373c_eval', 'boards/arm/stm32373c_eval/doc/index'), |
| ('boards/arm/stm32_min_dev/doc/stm32_min_dev', 'boards/arm/stm32_min_dev/doc/index'), |
| ('boards/arm/stm32f072_eval/doc/stm32f072_eval', 'boards/arm/stm32f072_eval/doc/index'), |
| ('boards/arm/stm32f072b_disco/doc/stm32f072b_disco', 'boards/arm/stm32f072b_disco/doc/index'), |
| ('boards/arm/stm32f0_disco/doc/stm32f0_disco', 'boards/arm/stm32f0_disco/doc/index'), |
| ('boards/arm/stm32f3_disco/doc/stm32f3_disco', 'boards/arm/stm32f3_disco/doc/index'), |
| ('boards/arm/stm32f411e_disco/doc/stm32f411e_disco', 'boards/arm/stm32f411e_disco/doc/index'), |
| ('boards/arm/stm32f412g_disco/doc/stm32f412g_disco', 'boards/arm/stm32f412g_disco/doc/index'), |
| ('boards/arm/stm32f429i_disc1/doc/stm32f429i_disc1', 'boards/arm/stm32f429i_disc1/doc/index'), |
| ('boards/arm/stm32f469i_disco/doc/stm32f469i_disco', 'boards/arm/stm32f469i_disco/doc/index'), |
| ('boards/arm/stm32f4_disco/doc/stm32f4_disco', 'boards/arm/stm32f4_disco/doc/index'), |
| ('boards/arm/stm32f723e_disco/doc/stm32f723e_disco', 'boards/arm/stm32f723e_disco/doc/index'), |
| ('boards/arm/stm32f746g_disco/doc/stm32f746g_disco', 'boards/arm/stm32f746g_disco/doc/index'), |
| ('boards/arm/stm32f769i_disco/doc/stm32f769i_disco', 'boards/arm/stm32f769i_disco/doc/index'), |
| ('boards/arm/stm32l476g_disco/doc/stm32l476g_disco', 'boards/arm/stm32l476g_disco/doc/index'), |
| ('boards/arm/stm32l496g_disco/doc/stm32l496g_disco', 'boards/arm/stm32l496g_disco/doc/index'), |
| ('boards/arm/udoo_neo_full_m4/doc/udoo_neo_full', 'boards/arm/udoo_neo_full_m4/doc/index'), |
| ('boards/arm/usb_kw24d512/doc/usb_kw24d512', 'boards/arm/usb_kw24d512/doc/index'), |
| ('boards/arm/v2m_beetle/doc/v2m_beetle', 'boards/arm/v2m_beetle/doc/index'), |
| ('boards/arm/warp7_m4/doc/warp7_m4', 'boards/arm/warp7_m4/doc/index'), |
| ('boards/nios2/altera_max10/doc/board', 'boards/nios2/altera_max10/doc/index'), |
| ('boards/nios2/qemu_nios2/doc/board', 'boards/nios2/qemu_nios2/doc/index'), |
| ('boards/posix/native_posix/doc/board', 'boards/posix/native_posix/doc/index'), |
| ('boards/riscv/hifive1/doc/hifive1', 'boards/riscv/hifive1/doc/index'), |
| ('boards/riscv/m2gl025_miv/doc/m2g1025_miv', 'boards/riscv/m2gl025_miv/doc/index'), |
| ('boards/riscv/qemu_riscv32/doc/board', 'boards/riscv/qemu_riscv32/doc/index'), |
| ('boards/riscv/zedboard_pulpino/doc/zedboard_pulpino', 'boards/riscv/zedboard_pulpino/doc/index'), |
| ('boards/riscv/hifive1/doc/index', 'boards/riscv/hifive1/doc/index'), |
| ('boards/riscv/hifive1_revb/doc/index', 'boards/riscv/hifive1_revb/doc/index'), |
| ('boards/riscv/litex_vexriscv/doc/litex_vexriscv', 'boards/riscv/litex_vexriscv/doc/litex_vexriscv'), |
| ('boards/riscv/m2gl025_miv/doc/index', 'boards/riscv/m2gl025_miv/doc/index'), |
| ('boards/riscv/qemu_riscv32/doc/index', 'boards/riscv/qemu_riscv32/doc/index'), |
| ('boards/riscv/rv32m1_vega/doc/index', 'boards/riscv/rv32m1_vega/doc/index'), |
| ('boards/x86/arduino_101/doc/board', 'boards/x86/arduino_101/doc/index'), |
| ('boards/x86/galileo/doc/galileo', 'boards/x86/galileo/doc/index'), |
| ('boards/x86/minnowboard/doc/minnowboard', 'boards/x86/minnowboard/doc/index'), |
| ('boards/x86/qemu_x86/doc/board', 'boards/x86/qemu_x86/doc/index'), |
| ('boards/x86/tinytile/doc/board', 'boards/x86/tinytile/doc/index'), |
| ('boards/x86/up_squared/doc/up_squared', 'boards/x86/up_squared/doc/index'), |
| ('boards/x86/x86_jailhouse/doc/board', 'boards/x86/x86_jailhouse/doc/index'), |
| ('boards/xtensa/esp32/doc/esp32', 'boards/xtensa/esp32/doc/index'), |
| ('boards/xtensa/intel_s1000_crb/doc/intel_s1000', 'boards/xtensa/intel_s1000_crb/doc/index'), |
| ('boards/xtensa/qemu_xtensa/doc/board', 'boards/xtensa/qemu_xtensa/doc/index'), |
| ('boards/xtensa/xt-sim/doc/xt-sim', 'boards/xtensa/xt-sim/doc/index'), |
| ] |
| |
| # -- Options for LaTeX output --------------------------------------------- |
| |
| latex_elements = { |
| # The paper size ('letterpaper' or 'a4paper'). |
| #'papersize': 'letterpaper', |
| |
| # The font size ('10pt', '11pt' or '12pt'). |
| #'pointsize': '10pt', |
| |
| # Additional stuff for the LaTeX preamble. |
| 'preamble': r'\setcounter{tocdepth}{2}', |
| |
| # Latex figure (float) alignment |
| #'figure_align': 'htbp', |
| } |
| |
| # Grouping the document tree into LaTeX files. List of tuples |
| # (source start file, target name, title, |
| # author, documentclass [howto, manual, or own class]). |
| latex_documents = [ |
| (master_doc, 'zephyr.tex', u'Zephyr Project Documentation', |
| u'many', 'manual'), |
| ] |
| |
| # The name of an image file (relative to this directory) to place at the top of |
| # the title page. |
| #latex_logo = None |
| |
| # For "manual" documents, if this is true, then toplevel headings are parts, |
| # not chapters. |
| #latex_use_parts = False |
| |
| # If true, show page references after internal links. |
| #latex_show_pagerefs = False |
| |
| # If true, show URL addresses after external links. |
| #latex_show_urls = False |
| |
| # Documents to append as an appendix to all manuals. |
| #latex_appendices = [] |
| |
| # If false, no module index is generated. |
| #latex_domain_indices = True |
| |
| # -- Options for manual page output --------------------------------------- |
| |
| # One entry per manual page. List of tuples |
| # (source start file, name, description, authors, manual section). |
| man_pages = [ |
| (master_doc, 'zephyr', u'Zephyr Project Documentation', |
| [author], 1) |
| ] |
| |
| # If true, show URL addresses after external links. |
| #man_show_urls = False |
| |
| |
| # -- Options for Texinfo output ------------------------------------------- |
| |
| # Grouping the document tree into Texinfo files. List of tuples |
| # (source start file, target name, title, author, |
| # dir menu entry, description, category) |
| texinfo_documents = [ |
| (master_doc, 'zephyr', u'Zephyr Project Documentation', |
| author, 'Zephyr', 'One line description of project.', |
| 'Miscellaneous'), |
| ] |
| |
| # Documents to append as an appendix to all manuals. |
| #texinfo_appendices = [] |
| |
| # If false, no module index is generated. |
| #texinfo_domain_indices = True |
| |
| # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| #texinfo_show_urls = 'footnote' |
| |
| # If true, do not generate a @detailmenu in the "Top" node's menu. |
| #texinfo_no_detailmenu = False |
| |
| breathe_projects = { |
| "Zephyr": "{}/doxygen/xml".format(ZEPHYR_BUILD), |
| "doc-examples": "{}/doxygen/xml".format(ZEPHYR_BUILD) |
| } |
| breathe_default_project = "Zephyr" |
| |
| # Changing breathe configuration to force "c" domain doesn't work |
| # see https://github.com/michaeljones/breathe/issues/282 |
| #breathe_domain_by_extension = { |
| # "h" : "c", |
| # "c" : "c", |
| # } |
| |
| # Qualifiers to a function are causing Sphihx/Breathe to warn about |
| # Error when parsing function declaration and more. This is a list |
| # of strings that the parser additionally should accept as |
| # attributes. |
| cpp_id_attributes = ['__syscall', '__deprecated', |
| '__may_alias', '__used', '__unused', '__weak', |
| '__DEPRECATED_MACRO', 'FUNC_NORETURN'] |
| |
| # docs_title is used in the breadcrumb title in the zephyr docs theme |
| html_context = { |
| 'show_license': html_show_license, |
| 'docs_title': docs_title, |
| 'is_release': is_release, |
| 'theme_logo_only': False, |
| 'current_version': version, |
| 'versions': (("latest", "/"), |
| ("2.1.0", "/2.1.0/"), |
| ("2.0.0", "/2.0.0/"), |
| ("1.14.1", "/1.14.1/"), |
| ("1.13.0", "/1.13.0/"), |
| ("1.12.0", "/1.12.0/"), |
| ("1.11.0", "/1.11.0/"), |
| ) |
| } |
| |
| |
| extlinks = {'jira': ('https://jira.zephyrproject.org/browse/%s', ''), |
| 'github': ('https://github.com/zephyrproject-rtos/zephyr/issues/%s', '') |
| } |
| |
| # some configuration for linkcheck builder |
| # noticed that we're getting false-positive link errors on JIRA, I suspect |
| # because it's taking too long for the server to respond so bump up the |
| # timeout (default=5) and turn off anchor checks (so only a HEAD request is |
| # done - much faster) Leave the ignore commented in case we want to remove |
| # jira link checks later... |
| |
| linkcheck_timeout = 30 |
| linkcheck_workers = 10 |
| # linkcheck_ignore = [r'https://jira\.zephyrproject\.org/'] |
| linkcheck_anchors = False |
| |
| def setup(app): |
| app.add_stylesheet("zephyr-custom.css") |
| |
| app.add_javascript("https://www.googletagmanager.com/gtag/js?id=UA-831873-47") |
| app.add_javascript("ga-tracker.js") |
| app.add_javascript("zephyr-custom.js") |
