Home
last modified time | relevance | path

Searched +full:doc +full:- +full:build +full:- +full:html (Results 1 – 25 of 56) sorted by relevance

123

/Zephyr-latest/.github/workflows/
Ddoc-build.yml2 # SPDX-License-Identifier: Apache-2.0
4 name: Documentation Build
8 - cron: '0 */3 * * *'
11 - v*
22 # and each sphinx-build process may use more than 2GiB of RAM.
26 doc-file-check:
27 name: Check for doc changes
28 runs-on: ubuntu-22.04
30 github.repository_owner == 'zephyrproject-rtos'
32 file_check: ${{ steps.check-doc-files.outputs.any_modified }}
[all …]
Ddoc-publish.yml3 # SPDX-License-Identifier: Apache-2.0
9 workflows: ["Documentation Build"]
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
[all …]
Ddoc-publish-pr.yml3 # SPDX-License-Identifier: Apache-2.0
9 workflows: ["Documentation Build"]
11 - completed
14 doc-publish:
16 runs-on: ubuntu-22.04
20 github.repository == 'zephyrproject-rtos/zephyr'
23 - name: Download artifacts
24 id: download-artifacts
25 uses: dawidd6/action-download-artifact@v6
27 workflow: doc-build.yml
[all …]
/Zephyr-latest/doc/contribute/documentation/
Dgeneration.rst11 .. _documentation-overview:
18 using Sphinx to create a formatted stand-alone website. Developers can
20 can generate the HTML content and view it with a web browser directly on
32 are found in the ``/doc`` directory, but others are stored within the
36 * Doxygen-generated material used to create all API-specific documents
39 * Script-generated material for kernel configuration options based on Kconfig
43 :caption: Schematic of the documentation build process
51 rtd [shape="rectangle" label="read-the-docs\ntheme"]
54 html [shape="rectangle" label="HTML\nweb site"]
56 images -> sphinx
[all …]
Dguidelines.rst16 Sphinx installed) they can :ref:`build the documentation <zephyr_doc>` locally
17 to generate the documentation in HTML or PDF format. The HTML content can
24 .. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html
25 .. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.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
[all …]
/Zephyr-latest/
D.gitignore14 build*/
15 !doc/build/
16 !scripts/build
25 # no suitable out-of-tree directory is found.
29 outdir-*
32 coverage-report
33 doc-coverage.info
34 doc/_build
35 doc/doxygen
36 doc/xml
[all …]
DMAINTAINERS.yml45 # files-regex:
56 # files-exclude:
59 # files-regex-exclude:
60 # Like 'files-regex', but any matching files will be excluded from the
63 # description: >-
64 # Plain-English description. Describe what the system is about, from an
68 # All areas must have a 'files' and/or 'files-regex' key. The other keys are
72 # this would be sub-areas which add extra fields (for ex. more `collaborators`
73 # who work only in that sub-area) to other areas.
98 # Collaborators: <list of sub-maintainers>
[all …]
/Zephyr-latest/doc/
Dconf.py1 # Zephyr documentation build configuration file.
2 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
15 sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions"))
19 sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_scripts"))
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 ------------------------------------------------
[all …]
DCMakeLists.txt1 # SPDX-License-Identifier: Apache-2.0
4 project(Zephyr-Kernel-Doc LANGUAGES)
7 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE} .. COMPONENTS doc)
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 #-------------------------------------------------------------------------------
31 find_program(SPHINXBUILD sphinx-build)
33 message(FATAL_ERROR "The 'sphinx-build' command was not found")
35 find_program(SPHINXAUTOBUILD sphinx-autobuild)
[all …]
/Zephyr-latest/doc/develop/sca/
Dsparse.rst6 `Sparse <https://www.kernel.org/doc/html/latest/dev-tools/sparse.html>`__
21 To run a sparse verification build :ref:`west build <west-building>` should be
22 called with a ``-DZEPHYR_SCA_VARIANT=sparse`` parameter, e.g.
24 .. code-block:: shell
26 … west build -d hello -b intel_adsp/cavs25 zephyr/samples/hello_world -- -DZEPHYR_SCA_VARIANT=sparse
Declair.rst9 particular emphasis on the MISRA and BARR-C coding standards, to the
22 To run ECLAIR, :ref:`west build <west-building>` should be
23 called with a ``-DZEPHYR_SCA_VARIANT=eclair`` parameter.
25 .. code-block:: shell
27 west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair
43 .. code-block:: shell
45 …west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_OPTIONS_…
51 file, that can be achived by giving the argument ``-DOption=ON|OFF``.
55 .. code-block:: shell
57 …west build -b mimxrt1064_evk samples/basic/blinky -- -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_REPORTS_…
[all …]
/Zephyr-latest/tests/net/all/
Dcheck_net_options.sh5 # SPDX-License-Identifier: Apache-2.0
7 if [ -z "$1" ]; then
8 echo "Usage: $0 <doc build directory>"
10 echo "The parameter needs to point to a directory where Zephyr html"
12 echo "Typically this is $ZEPHYR_BASE/doc/_build"
21 if [ ! -d $build_dir ]; then
26 kconfig_dir=$build_dir/rst/doc/reference/kconfig
28 if [ ! -d $kconfig_dir ]; then
40 grep -q $opt prj.conf > /dev/null 2>&1
41 if [ $? -ne 0 ]; then
[all …]
/Zephyr-latest/cmake/modules/
DFindTargetTools.cmake1 # SPDX-License-Identifier: Apache-2.0
7 # +---------------------------------------------------------------+
9 # +---------------------------------------------------------------+
10 # | Target C-compiler | Yes | |
13 # +---------------------------------------------------------------+
19 # Set to 'CMAKE_C_COMPILER-NOTFOUND' if no C compiler was found.
34 # https://cmake.org/cmake/help/latest/variable/CMAKE_SYSTEM_NAME.html:
35 # The name of the operating system for which CMake is to build.
37 # https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/CrossCompiling:
42 # like Linux.cmake or Windows-gcc.cmake. If your target is an embedded
[all …]
/Zephyr-latest/boards/starfive/visionfive2/doc/
Dindex.rst7 multi-core 64bit RISC-V SoC.
18 .. zephyr-app-commands::
20 :goals: build
22 `spl_tool <https://github.com/starfive-tech/Tools/tree/master/spl_tool/>`_
26 .. code-block:: console
28 ./spl_tool -c -f build/zephyr/zephyr.bin
30 This will create a new file ``build/zephyr/zephyr.bin.normal.out`` that can be flashed.
32 to run it in M-Mode (Machine Mode) since S-Mode (Supervisor Mode) is
41 Thanks to @orangecms for his vf2-loader tool which makes the flashing process easier
43 git clone the vf2-loader tool from https://github.com/orangecms/vf2-loader.git and
[all …]
/Zephyr-latest/doc/_scripts/
Dredirects.py3 SPDX-License-Identifier: Apache-2.0
7 doc directories)
10 - Please keep this list sorted alphabetically.
11 - URLs must be relative to document root (with NO leading slash), and
12 without the html extension).
16 # zephyr-keep-sorted-start
18 ('boards/arduino/uno_r4_minima/doc/index', 'boards/arduino/uno_r4/doc/index'),
19 ('boards/phytec/mimx8mm_phyboard_polis/doc/index', 'boards/phytec/phyboard_polis/doc/index'),
20 ('boards/phytec/mimx8mp_phyboard_pollux/doc/index', 'boards/phytec/phyboard_pollux/doc/index'),
22 ('boards/rak/rak11720/doc/index', 'boards/rakwireless/rak11720/doc/index'),
[all …]
/Zephyr-latest/boards/intel/ehl/doc/
Dindex.rst22 .. include:: ../../../../soc/intel/elkhart_lake/doc/supported_features.txt
39 Build Zephyr application
42 #. Build a Zephyr application; for instance, to build the ``hello_world``
45 .. zephyr-app-commands::
46 :zephyr-app: samples/hello_world
48 :goals: build
53 created in the build directory after the application is built.
59 :start-after: start_include_here
65 :start-after: start_include_here
73 .. code-block:: console
[all …]
/Zephyr-latest/boards/lowrisc/opentitan_earlgrey/doc/
Dindex.rst9 The OpenTitan Earl Grey chip is a low-power secure microcontroller that is
17 - RV32IMCB RISC-V "Ibex" core
18 - 128kB main SRAM
19 - Fixed-frequency and AON timers
20 - 32 x GPIO
21 - 4 x UART
22 - 3 x I2C
23 - 2 x SPI host
24 - 1 x SPI device
25 - Various security peripherals
[all …]
/Zephyr-latest/samples/subsys/usb/webusb-next/
DREADME.rst1 .. zephyr:code-sample:: webusb-next
2 :name: WebUSB-next
3 :relevant-api: usbd_api
14 This sample can be found at :zephyr_file:`samples/subsys/usb/webusb-next` in the
22 WebUSB API, such as Chromium or a Chromium-based browser.
27 Build and flash webusb sample with:
29 .. zephyr-app-commands::
30 :zephyr-app: samples/subsys/usb/webusb-next
39 sample directory: :zephyr_file:`samples/subsys/usb/webusb-next/index.html`.
43 * Using browser go to :doc:`demo`
[all …]
/Zephyr-latest/tests/bsim/bluetooth/ll/edtt/
DREADME.txt8 and in its `doc/` folder.
11 1.) A controller only build of the BLE stack, where the HCI, and a few extra
32 `installed BabbleSim <https://babblesim.github.io/fetching.html>`_.
54 cd ${ZEPHYR_BASE} && source zephyr-env.sh
/Zephyr-latest/doc/releases/
Drelease-notes-1.5.rst7 1.5.0. This is the first release to follow the 3-month release cadence.
13 - TCP Support
14 - Integration of the Paho MQTT Library support with QoS
15 - Flash Filesystem Support
16 - Integration of the mbedTLS library for encryption
17 - Improved BR/EDR support (for L2CAP, in particular).
18 - Support for the Altera Nios II/f soft CPU architecture
25 - Added nano_fifo_put_list() APIs, which allows queuing a list of elements
27 - Removed unused memory pool structure field.
28 - Enhanced memory pool code.
[all …]
Drelease-notes-1.10.rst12 * Initial alpha-quality thread-level memory protection on x86, userspace and memory
14 * Major overhaul to the build system and a switch from Kbuild to CMake.
27 * Initial alpha-quality thread-level memory protection on x86, userspace and memory
35 * Memory domain APIs for fine-tuning memory region permissions
38 * Add the following application-facing memory domain APIs:
40 * k_mem_domain_init() - to initialize a memory domain
41 * k_mem_domain_destroy() - to destroy a memory domain
42 * k_mem_domain_add_partition() - to add a partition into a domain
43 * k_mem_domain_remove_partition() - to remove a partition from a domain
44 * k_mem_domain_add_thread() - to add a thread into a domain
[all …]
/Zephyr-latest/scripts/ci/
Dcheck_compliance.py5 # SPDX-License-Identifier: Apache-2.0
57 f"{cp.stdout.decode('utf-8')}\n"
59 f"{cp.stderr.decode('utf-8')}\n")
61 return cp.stdout.decode("utf-8").rstrip()
70 return git('rev-list',
71 f'--max-count={-1 if "." in refspec else 1}', refspec).split()
74 filter_arg = (f'--diff-filter={filter}',) if filter else ()
75 paths_arg = ('--', *paths) if paths else ()
76 out = git('diff', '--name-only', *filter_arg, COMMIT_RANGE, *paths_arg)
120 doc:
[all …]
/Zephyr-latest/boards/
DKconfig1 # SPDX-License-Identifier: Apache-2.0
38 When set, any build for that board will generate a clearly visible
41 https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
94 int "QEMU ivshmem-plain shared memory size in mega-bytes"
98 This sets the size of the shared memory when using ivshmem-plain
99 device in Qemu. Note that it's in mega-bytes, so 1 means 1M for Qemu
115 This options is passed onto QEMU as a parameter to `-gdb` option.
116 The default value is equivalent to `-s` which is a shorthand for
117 `-gdb tcp::1234`. An empty value omits the `-gdb` parameter altogether.
118 This allows the injection of `-gdb` parameter from other sources such
[all …]
/Zephyr-latest/samples/subsys/usb/webusb/
DREADME.rst1 .. zephyr:code-sample:: webusb
3 :relevant-api: _usb_device_core_api
8 https://developers.google.com/web/updates/2016/03/access-usb-devices-on-the-web
33 Build and flash webusb sample with:
35 .. zephyr-app-commands::
36 :zephyr-app: samples/subsys/usb/webusb
60 :zephyr_file:`samples/subsys/usb/webusb/index.html`.
68 * Using Chrome browser go to :doc:`demo`
73 .. code-block:: console
75 $ python -m http.server
[all …]
/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 …l.com/content/www/us/en/software-kit/684215/intel-quartus-prime-lite-edition-design-software-versi…
66 .. code-block:: console
[all …]

123