| /Zephyr-latest/doc/ |
| D | requirements.txt | 3 sphinx
5 sphinx-tabs
8 sphinx-notfound-page
9 sphinx-copybutton
10 sphinx-togglebutton
11 sphinx-sitemap
12 sphinx-autobuild
|
| D | CMakeLists.txt | 15 set(SPHINXOPTS "-j auto -W --keep-going -T" CACHE STRING "Default Sphinx Options")
16 set(SPHINXOPTS_EXTRA "" CACHE STRING "Extra Sphinx Options (added to defaults)")
31 find_program(SPHINXBUILD sphinx-build)
33 message(FATAL_ERROR "The 'sphinx-build' command was not found")
35 find_program(SPHINXAUTOBUILD sphinx-autobuild)
88 # This is useful to, e.g. re-run the Sphinx build without dependencies such as
166 COMMENT "Running Sphinx HTML build..."
196 COMMENT "Running Sphinx HTML autobuild..."
224 COMMENT "Running Sphinx LaTeX build..."
275 COMMENT "Running Sphinx link check..."
|
| D | conf.py | 2 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
13 # Add the '_extensions' directory to sys.path, to enable finding Sphinx
74 "sphinx.ext.todo",
75 "sphinx.ext.extlinks",
76 "sphinx.ext.autodoc",
77 "sphinx.ext.graphviz",
100 # Ensure "sphinxcontrib.rsvgconverter" is added before "sphinx.ext.imgconverter"
105 extensions.append("sphinx.ext.imgconverter")
116 pygments_style = "sphinx"
321 # -- Options for sphinx.ext.graphviz --------------------------------------
[all …]
|
| /Zephyr-latest/doc/_extensions/zephyr/doxytooltip/ |
| D | __init__.py | 8 A simple Sphinx extension that adds JS and CSS resources to the app
15 from sphinx.application import Sphinx
16 from sphinx.util import logging
22 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| /Zephyr-latest/doc/_extensions/zephyr/ |
| D | gh_utils.py | 2 Git/GitHub utilities for Sphinx
13 This Sphinx extension can be used to obtain various Git and GitHub related metadata for a page.
47 from sphinx.application import Sphinx
48 from sphinx.util.i18n import format_date
61 def get_page_prefix(app: Sphinx, pagename: str) -> str: argument
65 If pagename refers to a page that is automatically generated by Sphinx or if it matches one of
69 app: Sphinx instance.
92 def gh_link_get_url(app: Sphinx, pagename: str, mode: str = "blob") -> str | None: argument
96 app: Sphinx instance.
119 def gh_link_get_open_issue_url(app: Sphinx, pagename: str, sha1: str) -> str | None: argument
[all …]
|
| D | doxybridge.py | 14 from sphinx import addnodes
15 from sphinx.application import Sphinx
16 from sphinx.domains.c import CXRefRole
17 from sphinx.transforms.post_transforms import SphinxPostTransform
18 from sphinx.util import logging
19 from sphinx.util.docutils import SphinxDirective
61 """Mapping between Doxygen memberdef kind and Sphinx kinds"""
72 # "member", "data" and "var" are equivalent as per Sphinx documentation for C domain
181 def parse_index(app: Sphinx, inDirName): argument
197 def doxygen_parse(app: Sphinx) -> None: argument
[all …]
|
| D | doxyrunner.py | 2 Doxyrunner Sphinx Plugin
11 This Sphinx plugin can be used to run Doxygen build as part of the Sphinx build
16 - Doxygen build is run before Sphinx reads input files
54 from sphinx.application import Sphinx
55 from sphinx.environment import BuildEnvironment
56 from sphinx.util import logging
200 env: Sphinx build environment instance.
240 This function will map Doxygen output to the Sphinx logger output. Errors
241 and warnings will be converted to Sphinx errors and warnings. Other
337 def doxygen_build(app: Sphinx) -> None: argument
[all …]
|
| D | external_content.py | 11 This extension allows to import sources from directories out of the Sphinx
41 from sphinx.application import Sphinx
94 def sync_contents(app: Sphinx) -> None: argument
98 app: Sphinx application instance.
164 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | manifest_projects_table.py | 34 from sphinx.application import Sphinx
35 from sphinx.util.docutils import SphinxDirective
134 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | html_redirects.py | 24 # Adapted from ideas in https://tech.signavio.com/2017/managing-sphinx-redirects
27 from sphinx.builders.html import StandaloneHTMLBuilder
28 from sphinx.util import logging
|
| D | api_overview.py | 10 from sphinx.application import Sphinx
11 from sphinx.util.docutils import SphinxDirective
140 def sync_contents(app: Sphinx) -> None: argument
|
| D | dtcompatible-role.py | 6 A Sphinx extension for documenting devicetree content. It adds a role and a
|
| D | link-roles.py | 14 from sphinx.util import logging
|
| /Zephyr-latest/doc/contribute/documentation/ |
| D | generation.rst | 17 language (.rst file extension) with Sphinx extensions, and processed
18 using Sphinx to create a formatted stand-alone website. Developers can
25 You can read details about `reStructuredText`_, and `Sphinx`_ from
55 sphinx[shape="ellipse" label="sphinx +\ndocutils"]
56 images -> sphinx
57 rst -> sphinx
58 conf -> sphinx
61 xml-> sphinx
62 rtd -> sphinx
63 sphinx -> html
[all …]
|
| D | guidelines.rst | 13 language (.rst file extension) with Sphinx extensions, and processed
14 using Sphinx to create a formatted standalone website. Developers can
16 Sphinx installed) they can :ref:`build the documentation <zephyr_doc>` locally
22 and about `Sphinx extensions`_ from their respective websites.
24 .. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html
26 .. _Sphinx Inline Markup: http://sphinx-doc.org/markup/inline.html#inline-markup
30 Sphinx-defined directives and roles used to create the documentation
330 ``.. tab::``. Under the hood, we're using the `sphinx-tabs
331 <https://github.com/executablebooks/sphinx-tabs>`_ extension that's included
334 paragraphs, and such). You can read more about sphinx-tabs from the
[all …]
|
| /Zephyr-latest/doc/_templates/ |
| D | searchbox.html | 18 <li id="search-se-menuitem-sphinx" role="menuitemradio" tabindex="-1"
19 aria-label="Built-in search" onclick="switchSearchEngine('sphinx')">
47 // built-in Sphinx search otherwise.
50 engine = isBrowsingLatest ? "google" : "sphinx";
68 if(engine === "sphinx") {
78 "search-se-menuitem-" + (engine === "sphinx" ? "google" : "sphinx")
|
| D | layout.html | 33 the usual add_js_file()/add_css_file() Sphinx API.
|
| /Zephyr-latest/doc/_extensions/zephyr/kconfig/ |
| D | __init__.py | 12 many other domains, the Kconfig options are not rendered by Sphinx directly but
43 from sphinx.addnodes import pending_xref
44 from sphinx.application import Sphinx
45 from sphinx.builders import Builder
46 from sphinx.domains import Domain, ObjType
47 from sphinx.environment import BuildEnvironment
48 from sphinx.errors import ExtensionError
49 from sphinx.roles import XRefRole
50 from sphinx.util.display import progress_message
51 from sphinx.util.docutils import SphinxDirective
[all …]
|
| /Zephyr-latest/scripts/ |
| D | requirements-compliance.txt | 14 sphinx-lint
|
| /Zephyr-latest/doc/_extensions/zephyr/domain/ |
| D | __init__.py | 40 from sphinx import addnodes
41 from sphinx.application import Sphinx
42 from sphinx.domains import Domain, ObjType
43 from sphinx.environment import BuildEnvironment
44 from sphinx.roles import XRefRole
45 from sphinx.transforms import SphinxTransform
46 from sphinx.transforms.post_transforms import SphinxPostTransform
47 from sphinx.util import logging
48 from sphinx.util.docutils import SphinxDirective, switch_source_input
49 from sphinx.util.nodes import NodeMatcher, make_refnode
[all …]
|
| /Zephyr-latest/doc/_static/js/ |
| D | scorer.js | 4 * Copyright 2007-2018 by the Sphinx team
|
| /Zephyr-latest/doc/_doxygen/ |
| D | doxygen-awesome-zephyr.css | 72 /* adjust top and title to ~match Sphinx docs */
|
| /Zephyr-latest/doc/contribute/ |
| D | index.rst | 59 (reST) markup language and Sphinx documentation generator.
|
| /Zephyr-latest/doc/_extensions/zephyr/doxytooltip/static/ |
| D | doxytooltip.js | 32 * similarly, doxytooltip.css is added to the document's <head> by the Sphinx extension, but we
|
| /Zephyr-latest/doc/_scripts/ |
| D | gen_devicetree_rest.py | 443 # These files are 'orphans' in the Sphinx sense: they are not in
838 # separate Sphinx doc set. Since we also link to Zephyr
844 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
880 # Return the sphinx ':ref:' target name for a binding.
|
