third_party.pigweed.src/docs/index.rst
Wyatt Hepler b82f995f2b pw_docgen: Fix paths, multiple sources
- 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
2019-11-25 14:55:02 -08:00

17 lines
407 B
ReStructuredText

=======
Pigweed
=======
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.
.. toctree::
:maxdepth: 1
:hidden:
docs/embedded_cpp_guide
docs/style_guide
modules