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:
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
162          the ``Scripts`` folder of your Python installation path.
164          add this folder to your ``PATH`` environment variable. Follow
165          the instructions in `Windows Python Path`_ to add those if needed.
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 .
216    and **not the version-controlled original files in Zephyr**. Be
230    If you add or remove a file from the documentation, you need to re-run CMake.
235 .. code-block:: console
254 can be added to the ``doc/known-warnings.txt`` file.
259 - Multiple declarations of the same object are not supported
260 - Different objects (e.g. a struct and a function) can not share the same name
261 - Nested elements (e.g. in a struct or union) can not share the same name
263 Developer-mode Document Building
267 to temporarily stub-out the auto-generated Devicetree bindings documentation so
272    -DDT_TURBO_MODE=1
279    make html-fast
287 .. code-block:: console
289    $ python3 -m http.server -d _build/html
296    .. code-block:: console
298       $ python3 -m http.server -d _build/html --bind 127.0.0.1
309    TAGFILES = "/path/to/zephyr.tag=https://docs.zephyrproject.org/latest/doxygen/html/"
314 .. _reStructuredText: http://sphinx-doc.org/rest.html
315 .. _Sphinx: http://sphinx-doc.org/
316 .. _Windows Python Path: https://docs.python.org/3/using/windows.html#finding-the-python-executable