| /Zephyr-latest/doc/_extensions/zephyr/ |
| D | gh_utils.py | 47 from sphinx.application import Sphinx
61 def get_page_prefix(app: Sphinx, pagename: str) -> str: argument
92 def gh_link_get_url(app: Sphinx, pagename: str, mode: str = "blob") -> str | None: argument
119 def gh_link_get_open_issue_url(app: Sphinx, pagename: str, sha1: str) -> str | None: argument
166 def git_info_filter(app: Sphinx, pagename) -> tuple[str, str] | None: argument
224 def add_jinja_filter(app: Sphinx): argument
243 def setup(app: Sphinx): argument
|
| D | external_content.py | 41 from sphinx.application import Sphinx
94 def sync_contents(app: Sphinx) -> None: argument
164 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | doxybridge.py | 15 from sphinx.application import Sphinx
181 def parse_index(app: Sphinx, inDirName): argument
197 def doxygen_parse(app: Sphinx) -> None: argument
218 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | manifest_projects_table.py | 34 from sphinx.application import Sphinx
134 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | doxyrunner.py | 54 from sphinx.application import Sphinx
337 def doxygen_build(app: Sphinx) -> None: argument
382 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| D | api_overview.py | 10 from sphinx.application import Sphinx
140 def sync_contents(app: Sphinx) -> None: argument
|
| /Zephyr-latest/doc/_extensions/zephyr/doxytooltip/ |
| D | __init__.py | 15 from sphinx.application import Sphinx
22 def setup(app: Sphinx) -> dict[str, Any]: argument
|
| /Zephyr-latest/doc/ |
| 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)")
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..."
|
| /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
67 The reStructuredText files are processed by the Sphinx documentation system,
161 On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in
172 Sphinx supports easy customization of the generated documentation
215 This means that Sphinx warnings and errors refer to the **copies**,
|
| 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.
30 Sphinx-defined directives and roles used to create the documentation
344 `reStructuredText Interpreted Text Roles`_ as well as the `additional roles provided by Sphinx`_.
348 .. _additional roles provided by Sphinx: https://www.sphinx-doc.org/en/master/usage/restructuredtex…
366 Sphinx extends reST by supporting additional inline markup elements (called
368 meanings and allow style output formatting. (You can refer to the `Sphinx Inline Markup`_
423 Available replacement names are defined in an include file used during the Sphinx processing
[all …]
|
| /Zephyr-latest/doc/_extensions/zephyr/kconfig/ |
| D | __init__.py | 44 from sphinx.application import Sphinx
69 def kconfig_load(app: Sphinx) -> tuple[kconfiglib.Kconfig, dict[str, str]]: argument
286 def kconfig_build_resources(app: Sphinx) -> None: argument
440 app: Sphinx, argument
461 def setup(app: Sphinx): argument
|
| /Zephyr-latest/doc/_doxygen/ |
| D | doxygen-awesome-zephyr.css | 72 /* adjust top and title to ~match Sphinx docs */
|
| /Zephyr-latest/doc/_extensions/zephyr/domain/ |
| D | __init__.py | 41 from sphinx.application import Sphinx
911 def compute_sample_categories_hierarchy(app: Sphinx, env: BuildEnvironment) -> None: argument
930 app: Sphinx, pagename: str, templatename: str, context: dict[str, Any], doctree: nodes.Node argument
941 def load_board_catalog_into_domain(app: Sphinx) -> None: argument
|
| /Zephyr-latest/doc/contribute/ |
| D | index.rst | 59 (reST) markup language and Sphinx documentation generator.
|
| /Zephyr-latest/doc/releases/ |
| D | release-notes-1.11.rst | 173 * Addressed Sphinx-generated intra-page link issues
174 * Updated doc generation tools (Doxygen, Sphinx, Breathe, Docutils)
|
| D | release-notes-1.10.rst | 172 Sphinx directives now included.
176 using a new Sphinx extension to keep examples consistent.
|
| D | release-notes-1.12.rst | 270 * Improved Sphinx search results output (removed markup)
503 * :github:`6811` - Add ReST/Sphinx usage guide to our contributing documentation
555 * :github:`7032` - Have Sphinx search display txt not ReST as results
|
| D | release-notes-2.6.rst | 1007 * Doxygen is now run by Sphinx using the ``doxyrunner`` custom extension. The
1011 * Documentation known warnings are now filtered using a custom Sphinx extension:
1013 the Sphinx output and allows to use the ``-W`` option (treat warnings as
1017 * Sphinx is now run in parallel mode by default (``-j auto``).
2142 * :github:`21811` - Investigate using Doxygen-generated API docs vs. Sphinx/Breath API docs
|
| D | release-notes-1.13.rst | 681 * :github:`3845` - Enable Sphinx option doc_role='any' for improved reference linking
|
| D | release-notes-4.0.rst | 418 * Added :rst:dir:`zephyr:board` directive and :rst:role:`zephyr:board` role to mark Sphinx pages as
|
| D | release-notes-3.5.rst | 2320 * Upgraded Sphinx to 6.2
|
| D | release-notes-2.7.rst | 1007 * Kconfig options need to be referenced using the ``:kconfig:option:`` Sphinx role.
|
| /Zephyr-latest/doc/project/ |
| D | project_roles.rst | 390 * Code linters (Gitlint, Pylint, Ruff, Sphinx, etc.)
|
