Lines Matching +full:if +full:- +full:no +full:- +full:files +full:- +full:found
8 as we use to create the online documentation found at
11 .. _documentation-overview:
18 using Sphinx to create a formatted stand-alone website. Developers can
19 view this content either in its raw form as .rst markup files, or you
30 * ReStructuredText source files used to generate documentation found at the
32 are found in the ``/doc`` directory, but others are stored within the
36 * Doxygen-generated material used to create all API-specific documents
37 also found at https://docs.zephyrproject.org
39 * Script-generated material for kernel configuration options based on Kconfig
40 files found in the source code tree
51 rtd [shape="rectangle" label="read-the-docs\ntheme"]
56 images -> sphinx
57 rst -> sphinx
58 conf -> sphinx
59 header -> doxygen
60 doxygen -> xml
61 xml-> sphinx
62 rtd -> sphinx
63 sphinx -> html
67 The reStructuredText files are processed by the Sphinx documentation system,
68 and make use of the doxygen-generated API material.
72 .. _documentation-processors:
94 .. group-tab:: Linux
99 .. code-block:: console
101 pip install -U -r ~/zephyrproject/zephyr/doc/requirements.txt
105 .. code-block:: console
107 sudo apt-get install --no-install-recommends doxygen graphviz librsvg2-bin \
108 texlive-latex-base texlive-latex-extra latexmk texlive-fonts-recommended imagemagick
112 .. code-block:: console
114 sudo dnf install doxygen graphviz texlive-latex latexmk \
115 texlive-collection-fontsrecommended librsvg2-tools ImageMagick
119 .. code-block:: console
121 sudo swupd bundle-add texlive graphviz ImageMagick
125 .. code-block:: console
127 sudo pacman -S graphviz doxygen librsvg texlive-core texlive-bin \
128 texlive-latexextra texlive-fontsextra imagemagick
130 .. group-tab:: macOS
134 .. code-block:: console
136 pip install -U -r ~/zephyrproject/zephyr/doc/requirements.txt
140 .. code-block:: console
144 tlmgr install collection-fontsrecommended
146 .. group-tab:: Windows
150 .. code-block:: console
152 pip install -U -r %HOMEPATH$\zephyrproject\zephyr\doc\requirements.txt
156 .. code-block:: console
158 choco install doxygen.install graphviz strawberryperl miktex rsvg-convert imagemagick
161 On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in
165 the instructions in `Windows Python Path`_ to add those if needed.
173 appearance through the use of themes. Replace the theme files and do
175 The ``read-the-docs`` theme is installed as part of the
183 repo has all the .rst source files, extra tools, and Makefile for
188 .. code-block:: console
195 # Use cmake to configure a Ninja-based build system:
196 cmake -GNinja -B_build .
203 # If you modify or add .rst files, run ninja again:
213 along with dependencies referenced by those .rst files.
216 and **not the version-controlled original files in Zephyr**. Be
223 if generated, the PDF file is available at ``doc/_build/latex/zephyr.pdf``.
225 If you want to build the documentation from scratch just delete the contents
230 If you add or remove a file from the documentation, you need to re-run CMake.
235 .. code-block:: console
245 Developer-mode Document Building
249 to temporarily stub-out the auto-generated Devicetree bindings documentation so
254 -DDT_TURBO_MODE=1
261 make html-fast
269 .. code-block:: console
271 $ python3 -m http.server -d _build/html
278 .. code-block:: console
280 $ python3 -m http.server -d _build/html --bind 127.0.0.1
282 Alternatively, the documentation can be built with the ``make html-live``
283 (or ``make html-live-fast``) command, which will build the documentation, host
286 files.
302 .. _reStructuredText: http://sphinx-doc.org/rest.html
303 .. _Sphinx: http://sphinx-doc.org/
304 .. _Windows Python Path: https://docs.python.org/3/using/windows.html#finding-the-python-executable