third_party.pigweed.src/docs/modules.rst

=======
Modules
=======
Pigweed is a collection of embedded-focused and embedded-related modules.
Modules may contain code from multiple languages, including C, C++, and Python.

.. toctree::
  :maxdepth: 1
  :glob:

  */docs
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			`=======`
			`Modules`
			`=======`
docs: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`Pigweed is a collection of embedded-focused and embedded-related modules.`
			`Modules may contain code from multiple languages, including C, C++, and Python.`
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
			`.. toctree::`
			`:maxdepth: 1`
docs: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`:glob:`
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: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`*/docs`