| commit | baaa2d62a6911b3291f6777db940ebaa2b0e9fc5 | [log] [tgz] |
|---|---|---|
| author | Alexei Frolov <frolv@google.com> | Tue Nov 12 16:20:51 2019 -0800 |
| committer | Alexei Frolov <frolv@google.com> | Wed Nov 13 13:28:28 2019 -0800 |
| tree | 5e2e672978dcc50ad7db58cb4a13e4a59121add8 | |
| parent | 917756d925c4896a64f5fd765258c82c0f65378f [diff] |
Add pw_docgen module This change adds a module which builds documentation using Sphinx. Documentation files and assets are defined using a pw_doc_group GN template which lists out all of the sources as metadata. Another GN template, pw_doc_gen, collects the metadata from pw_doc_group targets into a JSON file and defines an action that runs a script to build the HTML docs. A docgen script is provided by the pw_docgen module. This script reads the JSON metadata file collected by a pw_doc_gen template, copies all of the source and resource files into a documentation tree, and runs Sphinx on the tree to render the docs as HTML. Change-Id: I97890f05d850d5119cbd3bbf48138cd82f22d56c
Pigweed is a collection of embedded-focused libraries, which we call "modules". These modules are designed for small-footprint MMU-less microcontrollers like the ST Micro STM32L452 or the Nordic NRF82832. The modules are designed to facilitate easy integration into existing codebases.
Pigweed is in the early stages of development.