third_party.pigweed.src/docs/modules.rst

=======
Modules
=======

.. toctree::
  :maxdepth: 1

  pw_bloat/bloat
  pw_docgen/docgen
  pw_dumb_io/docs
  pw_dumb_io_baremetal_stm32f429/docs
  pw_dumb_io_stdio/docs
  pw_preprocessor/docs
  pw_presubmit/docs
  pw_span/docs
  pw_status/docs
  pw_string/docs
  pw_test_server/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`
			`=======`

			`.. toctree::`
			`:maxdepth: 1`

			`pw_bloat/bloat`
			`pw_docgen/docgen`
pw_dumb_io: Update docs Add/update docs for the pw_dumb_io facade and backends. Configures GN build files such that all the backend docs are built even if the backend isn't in use. Change-Id: I91fca1cb2d3f5d4b57ae1f6991a89270a35be1c6 2019-12-06 21:06:01 +00:00			`pw_dumb_io/docs`
			`pw_dumb_io_baremetal_stm32f429/docs`
			`pw_dumb_io_stdio/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			`pw_preprocessor/docs`
Expand docs for a few modules - Add missing README.md for a few modules. - Start or expand docs.rst. Change-Id: Ic13c5f71f02259205ba990c93e0403d43f7b44b1 2019-12-05 18:52:31 +00:00			`pw_presubmit/docs`
			`pw_span/docs`
			`pw_status/docs`
pw_string: start docs; StringBuilder size report Change-Id: Id1dbc070b14a85aeb782606e85d566ed0347fcd4 2019-11-20 01:10:20 +00:00			`pw_string/docs`
Add pw_test_server module This change adds a pw_test_server module which implements a gRPC server for queueing and distributing unit tests across multiple test runners. The server is implemented as a Go library which can be imported and used by developers to build a custom unit test running infrastructure. To use the server, a UnitTestRunner interface that processes requests to run unit tests must be implemented and registered with the server. An implementation of this interface which runs unit test executables through an external command is provided alongside the server. An example program that uses the server library to run a unit test server is also provided within the module. This program uses the command-based test runners to run unit tests on a local machine. It is configurable through a config file, allowing multiple workers to be registered with the server. The program additionally doubles as a gRPC client for the server which can be invoked with the path to a unit test executable to schedule it to be run. Change-Id: I347d230370620395de09e277f9763d7df1c4abad 2019-12-04 19:06:23 +00:00			`pw_test_server/docs`