Lines Matching +full:repo +full:- +full:path

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
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 breathe extension for including the doxygen-generated API
72 .. _documentation-processors:
83   ``scripts/requirements-doc.txt``
94    .. group-tab:: Linux
98       .. code-block:: console
100          sudo apt-get install --no-install-recommends doxygen graphviz librsvg2-bin \
101          texlive-latex-base texlive-latex-extra latexmk texlive-fonts-recommended
105       .. code-block:: console
107          sudo dnf install doxygen graphviz texlive-latex latexmk \
108          texlive-collection-fontsrecommended librsvg2-tools
112       .. code-block:: console
114          sudo swupd bundle-add texlive graphviz
118       .. code-block:: console
120          sudo pacman -S graphviz doxygen librsvg texlive-core texlive-bin \
121          texlive-latexextra texlive-fontsextra
123    .. group-tab:: macOS
127       .. code-block:: console
131          tlmgr install collection-fontsrecommended
133    .. group-tab:: Windows
137       .. code-block:: console
139          choco install doxygen.install graphviz strawberryperl miktex rsvg-convert
142          On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in
143          the ``Scripts`` folder of your Python installation path.
145          add this folder to your ``PATH`` environment variable. Follow
146          the instructions in `Windows Python Path`_ to add those if needed.
156 The ``read-the-docs`` theme is installed as part of the
164 repo has all the .rst source files, extra tools, and Makefile for
169 .. code-block:: console
176    # Use cmake to configure a Ninja-based build system:
177    cmake -GNinja -B_build .
197    and **not the version-controlled original files in Zephyr**. Be
211    If you add or remove a file from the documentation, you need to re-run CMake.
216 .. code-block:: console
235 can be added to the ``doc/known-warnings.txt`` file.
240 - Multiple declarations of the same object are not supported
241 - Different objects (e.g. a struct and a function) can not share the same name
242 - Nested elements (e.g. in a struct or union) can not share the same name
244 Developer-mode Document Building
248 to temporarily stub-out the auto-generated Devicetree bindings documentation so
253    -DDT_TURBO_MODE=1
260    make html-fast
271    TAGFILES = "/path/to/zephyr.tag=https://docs.zephyrproject.org/latest/doxygen/html/"
276 .. _reStructuredText: http://sphinx-doc.org/rest.html
277 .. _Sphinx: http://sphinx-doc.org/
278 .. _Windows Python Path: https://docs.python.org/3/using/windows.html#finding-the-python-executable