Home
last modified time | relevance | path

Searched +full:doxygen +full:- (Results 1 – 25 of 57) sorted by relevance

123

/Zephyr-latest/doc/_extensions/zephyr/
Ddoxyrunner.py6 SPDX-License-Identifier: Apache-2.0
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
17 - Doxyfile can be optionally pre-processed so that variables can be inserted
18 - Changes in the Doxygen input files are tracked so that Doxygen build is only
20 - Synchronizes Doxygen XML output so that even if Doxygen is run only changed,
25 - https://github.com/michaeljones/breathe/issues/420
30 - ``doxyrunner_doxygen``: Path to the Doxygen binary.
31 - ``doxyrunner_doxyfile``: Path to Doxyfile.
32 - ``doxyrunner_outdir``: Doxygen build output directory (inserted to
[all …]
Dapi_overview.py2 # SPDX-License-Identifier: Apache-2.0
18 version it is present - all information extracted from Doxygen XML output.
24 api_overview_doxygen_xml_dir: Doxygen xml output directory
25 api_overview_doxygen_base_url: Doxygen base html directory
45 github_uri = "https://github.com/zephyrproject-rtos/zephyr/releases/tag/"
140 def sync_contents(app: Sphinx) -> None:
166 def setup(app) -> dict[str, Any]:
167 app.add_config_value("api_overview_doxygen_xml_dir", "html/doxygen/xml", "env")
168 app.add_config_value("api_overview_doxygen_base_url", "../../doxygen/html", "env")
170 app.add_directive("api-overview-table", ApiOverview)
[all …]
Ddoxybridge.py4 SPDX-License-Identifier: Apache-2.0
61 """Mapping between Doxygen memberdef kind and Sphinx kinds"""
65 def run(self, **kwargs: Any) -> None:
95 doxygen_target = f"{'_'.join(split[:-1])}.html#{split[-1][1:]}"
154 def parse_compound(inDirName, baseName) -> dict:
197 def doxygen_parse(app: Sphinx) -> None:
218 def setup(app: Sphinx) -> dict[str, Any]:
226 app.connect("builder-inited", doxygen_parse)
/Zephyr-latest/doc/project/
Ddocumentation.rst1 .. _code-documentation:
10 requirement for defining an API's success. Doxygen is a general purpose
12 generates either an on-line documentation browser (in HTML) and/or provides
14 documented source files. In particular, doxygen's XML output is used as an input
44 :ref:`Ztest framework <test-framework>`. Test documentation should only be done
52 scheme and following a well-defined structure we will be able to group this
56 - All test code documentation should be grouped under the ``all_tests`` doxygen
58 - All test documentation should be under doxygen groups that are prefixed
61 The custom doxygen ``@verify`` directive signifies that a test verifies a
90 requirements, we use the ``satisfy`` alias in doxygen::
[all …]
/Zephyr-latest/doc/
Dzephyr.doxyfile.in4 # Doxygen (www.doxygen.org) for a project.
18 # Use Doxygen to compare the used configuration file with the template
20 # doxygen -x [configFile]
21 # Use Doxygen to compare the used configuration file with the template
24 # doxygen -x_noenv [configFile]
26 #---------------------------------------------------------------------------
28 #---------------------------------------------------------------------------
31 # file that follow. The default is UTF-8 which is also the encoding used for all
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
35 # The default value is: UTF-8.
[all …]
DMakefile1 # ------------------------------------------------------------------------------
3 # SPDX-License-Identifier: Apache-2.0
7 SPHINXOPTS ?= -j auto -W --keep-going -T
9 LATEXMKOPTS ?= -halt-on-error -no-shell-escape
12 # ------------------------------------------------------------------------------
15 .PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
17 html-fast:
20 html-live-fast:
21 ${MAKE} html-live DT_TURBO_MODE=1
23 html html-live latex pdf linkcheck doxygen: configure target
[all …]
DCMakeLists.txt1 # SPDX-License-Identifier: Apache-2.0
4 project(Zephyr-Kernel-Doc LANGUAGES)
12 #-------------------------------------------------------------------------------
15 set(SPHINXOPTS "-j auto -W --keep-going -T" CACHE STRING "Default Sphinx Options")
17 set(LATEXMKOPTS "-halt-on-error -no-shell-escape" CACHE STRING "Default latexmk options")
26 #-------------------------------------------------------------------------------
29 find_package(Doxygen REQUIRED dot)
31 find_program(SPHINXBUILD sphinx-build)
33 message(FATAL_ERROR "The 'sphinx-build' command was not found")
35 find_program(SPHINXAUTOBUILD sphinx-autobuild)
[all …]
Drequirements.txt5 sphinx-tabs
6 sphinxcontrib-svg2pdfconverter
8 sphinx-notfound-page
9 sphinx-copybutton
10 sphinx-togglebutton
11 sphinx-sitemap
12 sphinx-autobuild
18 # Used by pytest-twister-harness plugin (imported by autodoc)
22 # Doxygen doxmlparser
Dconf.py2 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
25 # Add the directory which contains the pytest-twister-pytest
26 sys.path.insert(0, str(ZEPHYR_BASE / "scripts" / "pylib" / "pytest-twister-harness" / "src"))
35 # -- Project --------------------------------------------------------------
38 copyright = "2015-2024 Zephyr Project members and individual contributors"
62 version += "-" + extra
70 # -- General configuration ------------------------------------------------
82 "zephyr.dtcompatible-role",
83 "zephyr.link-roles",
103 if tags.has("convertimages"): # pylint: disable=undefined-variable # noqa: F821
[all …]
/Zephyr-latest/doc/contribute/documentation/
Dgeneration.rst11 .. _documentation-overview:
18 using Sphinx to create a formatted stand-alone website. Developers can
36 * Doxygen-generated material used to create all API-specific documents
39 * Script-generated material for kernel configuration options based on Kconfig
51 rtd [shape="rectangle" label="read-the-docs\ntheme"]
56 images -> sphinx
57 rst -> sphinx
58 conf -> sphinx
59 header -> doxygen
60 doxygen -> xml
[all …]
Dguidelines.rst24 .. _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
42 the first non-white space in the preceding line. For example::
50 .. code-block::
66 * Third section heading level (h4) use ``-``
84 For bullet lists, place an asterisk (``*``) or hyphen (``-``) at
113 #. This is a second-level list under the first item (also
143 Multi-column lists
148 a special ``.. rst-class:: rst-columns`` directive. The directive will
[all …]
/Zephyr-latest/doc/_doxygen/
Dheader.html1 <!-- HTML header for doxygen 1.12.0-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xh…
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="generator" content="Doxygen $doxygenversion"/>
8 <meta name="viewport" content="width=device-width, initial-scale=1"/>
9 <!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
10 <!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
11 <!--BEGIN PROJECT_ICON-->
12 <link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
[all …]
Ddoxygen-awesome-sidebar-only-darkmode-toggle.css4 Doxygen Awesome
5 https://github.com/jothepro/doxygen-awesome-css
9 Copyright (c) 2021 - 2023 jothepro
31 @media screen and (min-width: 768px) {
34 …width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - var(--searchbar-height…
38 …width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - 66px - var(--searchbar…
Ddoxygen-awesome.css3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
8 Copyright (c) 2021 - 2023 jothepro
32 --primary-color: #1779c4;
33 --primary-dark-color: #335c80;
34 --primary-light-color: #70b1e9;
37 --page-background-color: #ffffff;
38 --page-foreground-color: #2f4153;
39 --page-secondary-foreground-color: #6f7e8e;
42 --separator-color: #dedede;
[all …]
Ddoxygen-awesome-sidebar-only.css3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
8 Copyright (c) 2021 - 2023 jothepro
34 --side-nav-fixed-width: 335px;
35 --menu-display: none;
37 --top-height: 120px;
38 --toc-sticky-top: -25px;
39 --toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
43 white-space: nowrap;
47 @media screen and (min-width: 768px) {
[all …]
Ddoxygen-awesome-darkmode-toggle.js3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
8 Copyright (c) 2021 - 2023 jothepro
33 // https://www.apache.org/licenses/LICENSE-2.0.html
34 …-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FCBF00"><rect fi…
35 …-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FE9700"><rect fi…
38 static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode"
39 static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode"
45 window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
61 const toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
[all …]
/Zephyr-latest/.github/workflows/
Ddoc-build.yml2 # SPDX-License-Identifier: Apache-2.0
8 - cron: '0 */3 * * *'
11 - v*
22 # and each sphinx-build process may use more than 2GiB of RAM.
26 doc-file-check:
28 runs-on: ubuntu-22.04
30 github.repository_owner == 'zephyrproject-rtos'
32 file_check: ${{ steps.check-doc-files.outputs.any_modified }}
34 - name: checkout
38 fetch-depth: 0
[all …]
Ddoc-publish.yml3 # SPDX-License-Identifier: Apache-2.0
11 - main
12 - v*
14 - completed
17 doc-publish:
19 runs-on: ubuntu-22.04
23 github.repository == 'zephyrproject-rtos/zephyr'
26 - name: Download artifacts
27 uses: dawidd6/action-download-artifact@v6
29 workflow: doc-build.yml
[all …]
/Zephyr-latest/doc/_extensions/zephyr/doxytooltip/static/
Ddoxytooltip.js3 * SPDX-License-Identifier: Apache-2.0
6 * Doxygen documentation as tooltips when hovering over a symbol in the
18 tooltipShadow.id = 'doxytooltip-shadow';
25 const tippyStyle = document.querySelector('style[data-tippy-stylesheet]');
58 .shadowRoot.getElementById('doxytooltip-shadow'),
70 /* Grab the main stylesheets from the Doxygen page and inject them in the tooltip's
72 const doxygenCSSNames = ['doxygen-awesome.css', 'doxygen-awesome-zephyr.css'];
91 if (codeClasses.contains('c-enumerator')) {
96 } else if (codeClasses.contains('c-struct')) {
99 /* c-function, c-type, etc. */
[all …]
Ddoxytooltip.css1 .tippy-box[data-theme~='doxytooltip'] {
2 /* provide minimal definition of the CSS variables used by Doxygen Awesome so that we have a
5 …--font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New'…
6 --primary-color: var(--navbar-heading-color);
7 --param-color: var(--code-literal-color);
8 --border-radius-small: 4px;
9 --border-radius-medium: 6px;
10 --border-radius-large: 8px;
12 background-color: var(--content-wrap-background-color);
13 color: var(--body-color);
[all …]
/Zephyr-latest/doc/_extensions/zephyr/doxytooltip/
D__init__.py2 Doxygen Tooltip Extension
6 SPDX-License-Identifier: Apache-2.0
22 def setup(app: Sphinx) -> dict[str, Any]:
26 app.add_js_file("tippy/tippy-bundle.umd.min.js")
/Zephyr-latest/doc/templates/
Dsample.tmpl1 .. zephyr:code-sample:: a_unique_id_for_the_sample
3 :relevant-api: space-separated list of Doxygen groups of APIs this sample is a good showcase of
29 [When showing code-blocks with sample build command instructions, use the
30 ..zephyr-app-commands directive (see the doc guidelines) instead of a
31 hand-written code-block.]
/Zephyr-latest/
D.gitignore25 # no suitable out-of-tree directory is found.
29 outdir-*
32 coverage-report
33 doc-coverage.info
35 doc/doxygen
41 doc/themes/zephyr-docs-theme
42 sanity-out*
43 twister-out*
55 hide-defaults-note
/Zephyr-latest/boards/intel/socfpga_std/cyclonev_socdk/doc/
Dindex.rst37 * J26: Short pins 1-2
38 * J27: Short pins 2-3
39 * J28: Short pins 1-2
40 * J29: Short pins 2-3
41 * J30: Short pins 1-2
48 * SW3: ON-OFF-ON-OFF-ON-ON
49 * SW4: OFF-OFF-ON-ON
51 Other switches are user switches, their position is application-specific.
58 ….intel.com/content/www/us/en/software-kit/684215/intel-quartus-prime-lite-edition-design-software-…
66 .. code-block:: console
[all …]
/Zephyr-latest/doc/releases/
Drelease-notes-1.6.rst7 release introduces the unified Kernel replacing the separate nano- and
8 micro-kernels and simplifying the overall Zephyr architecture and programming
10 Support for the ARM Cortex-M0/M0+ family was added and board support for
11 Cortex-M was expanded.
22 * Added support for several ARM Cortex-M boards
34 * Added DLIST to operate in all elements of a doubly-linked list.
52 * ARM: Added support for ARM Cortex-M0/M0+.
55 * x86: Changed IRQ controller to return -1 if cannot determine source vector.
99 * Added raw HCI API to enable physical HCI transport for a Controller-only build.
101 * Added cross-transport pairing support for the Security Manager Protocol.
[all …]

123