- Fix code for remapping paths into the docgen tree. Some path prefixes
were being incorrectly trimmed, preventing size report inclusion in
some cases.
- Make Sphinx warnings errors.
- Allow specifying multiple top-level sources to a pw_doc_gen.
- Move documentation for modules to their own table of contents.
- Rename module documentation to the module names.
Change-Id: Ic475019673ccefdb786a28d241a143886af097ab
This change adds documentation for the pw_docgen module describing how
to use it to build documentation for Pigweed projects.
Change-Id: Ia8bb57d26b96f748adc021cc86f0a16865611295
This change adds a docs directory at the root level of the Pigweed
repository for building documentation for the entirety of Pigweed.
The directory contains a top-level index.rst and conf.py for docgen,
and a pw_doc_gen build target to render the documentation.
Change-Id: Iba981c64662d48a1d23bb7bda9bf0ed5a104873b
This change updates the bloat script to output an RST version of its
report card table. Metadata is added to the bloat_report GN template
indicating its RST output, allowing it to be listed as a dependency of
pw_doc_group targets.
Change-Id: I3f098d352856a9dd8688bac44e3b60ddbb97a3a6
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
