Lines Matching +full:ninja +full:- +full:build

11 .. _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
43    :caption: Schematic of the documentation build process
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
68 and make use of the doxygen-generated API material.
72 .. _documentation-processors:
94    .. group-tab:: Linux
97       required to build the documentation:
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
132       Install the Python dependencies required to build the documentation:
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
148       Install the Python dependencies required to build the documentation:
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
175 The ``read-the-docs`` theme is installed as part of the
188 .. code-block:: console
195    # Use cmake to configure a Ninja-based build system:
196    cmake -GNinja -B_build .
198    # Enter the build directory
201    # To generate HTML output, run ninja on the generated build system:
202    ninja html
203    # If you modify or add .rst files, run ninja again:
204    ninja html
206    # To generate PDF output, run ninja on the generated build system:
207    ninja pdf
211    The documentation build system creates copies in the build
216    and **not the version-controlled original files in Zephyr**. Be
225 If you want to build the documentation from scratch just delete the contents
226 of the build folder and run ``cmake`` and then ``ninja`` again.
230    If you add or remove a file from the documentation, you need to re-run CMake.
233 build the documentation directly from there:
235 .. code-block:: console
245 Developer-mode Document Building
249 to temporarily stub-out the auto-generated Devicetree bindings documentation so
250 the doc build process runs faster.
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
291 External projects that build upon Zephyr functionality and wish to refer to
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