Commit Graph

7 Commits

Author SHA1 Message Date
Armando Montanez
1d00120b02 Update readme and extend Pigweed documentation
Trims setup information out of the README.md, and pushes setup and
developer guides into their own pages.

Change-Id: I7fc80213e6a00c270fc9c664c8a7f54a19c05778
2020-03-05 23:38:31 +00:00
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
Wyatt Hepler
8635af956b Update Sphinx conf.py; add autodoc extension
Change-Id: I4754d7d2203da2d9364d11aca65474eb29505fbf
2019-12-05 16:33:33 -08:00
Wyatt Hepler
becb431e5f Apply pw format to the repository
Change-Id: I3c8e4f956dfe6c9e81d3069f72c30c5950852074
2019-12-05 09:31:11 -08:00
Wyatt Hepler
1a96094ce6 Fix copyright notices
- Add missing copright header in conf.py.
- Fix inconsistent copyright notice line breaking.

Change-Id: Ib78f7768643069c49ff986a48a176df9fd06e891
2019-11-27 22:34:02 +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