Commit Graph

7 Commits

Author SHA1 Message Date
Wyatt Hepler
ab4eb7ad68 Docs updates
- Update docs copyright.
- Remove duplicate title in index.rst.
- Update note about Python 2 compatibility, since most Pigweed code
  requires Python 3.

Change-Id: I9c61a55c622b162317ab7fc4c5eec5fdf292bb02
2020-01-09 13:58:35 -08:00
Armando Montanez
4222532288 Import README.md into pigweed docs
Replaces the contents of the Pigweed documentation landing page with
the README.md inlined and converted to rst.

Change-Id: I6457aaede5ca4c0585af4a00c388278fb14223f5
2020-01-03 00:44:56 +00:00
Armando Montanez
0874558cf3 docs: Add 'targets' section
Creates a new section in the docs for target documentation, and adds
some documentation for the stm32f429i-disc1 target.

Change-Id: I0ffbfa56a97458d850834fc0f670b32885b0d2b5
2019-12-12 21:15:16 +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