Commit Graph

7 Commits

Author SHA1 Message Date
Wyatt Hepler
f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00
Alexei Frolov
725b85bbe7 pw_bloat: Remove .rst from generated size reports
This change removes the .rst extension from the ReST size report files
generated by pw_bloat to prevent Sphinx from checking that they've been
added to a toctree. (Apparently including a file doesn't count as using
it.)

Change-Id: I4edc2db832bac0f370f563ac4f5c68692ad6f85e
2020-03-19 21:14:29 +00:00
Armando Montanez
0054a9be70 Docs: Add missing RST docs
Adds dcos.rst files for all modules lacking documentation.

Change-Id: Ief5594831d31fcb876381a4a3886382fab7d595e
2020-03-17 00:13:35 +00:00
Wyatt Hepler
3c4e5de42f Add or expand docs.rst
Change-Id: I18d1529088beb41b37be00a77ba8999f6b6f810a
2020-03-05 02:00:04 +00:00
Wyatt Hepler
2596fe5418 pw_string: Rename va_list Format to FormatVaList
On Windows, sometimes the va_list overload would be used when formatting
with a single argument. To avoid potential conflicts like these, the
va_list versions of string::Format and StringBuilder::Format are renamed
to FormatVaList.

Change-Id: Id29fae21b13ed420b13841a479e3748a1d3b91ce
2020-01-24 22:53:22 +00:00
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
Wyatt Hepler
fe85de25cf pw_string: start docs; StringBuilder size report
Change-Id: Id1dbc070b14a85aeb782606e85d566ed0347fcd4
2019-11-26 21:27:22 +00:00