third_party.pigweed.src/docs/index.rst

=======
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
Add root docs directory 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 2019-11-15 01:22:08 +00:00			`=======`
			`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::`
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 21:56:31 +00:00			`:maxdepth: 1`
			`:hidden:`
Add root docs directory 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 2019-11-15 01:22:08 +00:00
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 21:56:31 +00:00			`docs/embedded_cpp_guide`
			`docs/style_guide`
			`modules`