Lines Matching full:documentation

3 Documentation Generation
7 documentation on your local system using the same documentation sources
8 as we use to create the online documentation found at
13 Documentation overview
22 Project's public website documentation area (with a different theme
28 The project's documentation contains the following items:
30 * ReStructuredText source files used to generate documentation found at the
43    :caption: Schematic of the documentation build process
67 The reStructuredText files are processed by the Sphinx documentation system,
70 documentation locally, as described in the following sections.
74 Installing the documentation processors
77 Our documentation processing has been tested to run with:
85 In order to install the documentation tools, first install Zephyr as
87 that are only required to generate the documentation,
97       required to build the documentation:
132       Install the Python dependencies required to build the documentation:
148       Install the Python dependencies required to build the documentation:
169 Documentation presentation theme
172 Sphinx supports easy customization of the generated documentation
179 Running the documentation processors
184 generating a local copy of the Zephyr project's technical documentation.
211    The documentation build system creates copies in the build
212    directory of every .rst file used to generate the documentation,
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.
233 build the documentation directly from there:
248 When making and testing major changes to the documentation, we provide an option
249 to temporarily stub-out the auto-generated Devicetree bindings documentation so
263 Viewing generated documentation locally
266 The generated HTML documentation can be hosted locally with python for viewing
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
284 it locally, and watch the documentation directory for changes. When changes are
285 observed, it will automatically rebuild the documentation and refresh the hosted
292 Zephyr documentation in Doxygen (through the use of @ref), can utilize the
299 For additional information refer to `Doxygen External Documentation`_.
305 .. _Doxygen External Documentation: https://www.doxygen.nl/manual/external.html