Lines Matching full:documentation

6 The docgen module provides tools to generate documentation for Pigweed-based
11 documentation. Docgen provides a convenient way to combine all of the relevant
12 documentation for a project into one place, allowing downstream consumers of
14 unified source of documentation early on.
16 The documentation generation is integrated directly into the build system. Any
17 build target can depend on documentation, which allows it to be included as part
18 of a factory release build, for example. Additionally, documentation itself can
20 Any time the code is changed, documentation will be regenerated with the updated
23 Documentation Overview
25 Each Pigweed module provides documentation describing its functionality, use
28 Included in a module's documentation are report cards which show an overview of
35 Pigweed documentation files are written in `reStructuredText`_ format and
48 Documentation source and asset files are placed alongside code within a module
50 groups become available for import within a special documentation generation
60 The main template for defining documentation files is ``pw_doc_group``. It is
61 used to logically group a collection of documentation source files and assets.
63 defining the module's documentation. A ``pw_doc_group`` can depend on other
68 * ``sources``: RST documentation source files.
89 documentation for a project. It depends on registered ``pw_doc_group`` targets
94 the documentation. These are added at the root level of the built documentation
102 * ``deps``: List of all ``pw_doc_group`` targets required for the documentation.
117 Generating Documentation
122 using a subset of Pigweed's core documentation.
139 A documentation tree is created under the output directory. Each of the sources
159 This is the documentation tree which gets passed to Sphinx to build HTML output.
160 Imports within documentation files must be relative to this structure. In
161 practice, relative imports from within modules' documentation groups are
168 This module houses Pigweed-specific extensions for the Sphinx documentation
175 page of the documentation when it is rendered to HTML.
181 this for documentation builds intended for deployment on the web.