Commit Graph

8 Commits

Author SHA1 Message Date
Wyatt Hepler
ee3e02f6cb Expand docs for a few modules
- Add missing README.md for a few modules.
- Start or expand docs.rst.

Change-Id: Ic13c5f71f02259205ba990c93e0403d43f7b44b1
2019-12-09 17:13:47 -08:00
Armando Montanez
d2e4903a42 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-10 00:05:55 +00:00
Alexei Frolov
d0b2d48782 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-06 22:55:28 +00:00
Wyatt Hepler
fe85de25cf pw_string: start docs; StringBuilder size report
Change-Id: Id1dbc070b14a85aeb782606e85d566ed0347fcd4
2019-11-26 21:27:22 +00:00
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
Alexei Frolov
8ffcb91912 Documentation for docgen
This change adds documentation for the pw_docgen module describing how
to use it to build documentation for Pigweed projects.

Change-Id: Ia8bb57d26b96f748adc021cc86f0a16865611295
2019-11-25 22:49:59 +00:00
Keir Mierle
2c1e56bbf0 docs: Initial checkin of style & embedded guides
These will need a bunch of work still but are a reasonable starting
place.

Change-Id: I91a64a6910a4acb8d657c43cd67af9e60f39616a
2019-11-19 19:44:25 +00:00
Alexei Frolov
0efdb117e1
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-14 17:29:23 -08:00