third_party.pigweed.src/docs/module_guides.rst

.. _docs-module-guides:

=============
Module Guides
=============
Pigweed is a collection of embedded-focused and embedded-related modules.
Modules may contain code from multiple languages, including C, C++, Go, Rust,
Shell, Batch and Python.

.. toctree::
  :maxdepth: 1
  :glob:

  */docs
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 01:59:33 +00:00			`.. _docs-module-guides:`

docs: Various refinements ahead of launch This is a series of changes across the documentation to improve the overall first-user experience. Key changes: 1. New "Express setup" section in the "Getting Started" page. 2. Rename and reorder the left-hand menu bar components 3. Fix various copyright dates 4. Add presubmit animated gif to the pw_presubmit docs Change-Id: I22a75ace8c2be15a6e5890d6e1b3618a1d53eefa 2020-03-19 09:03:51 +00:00			`=============`
			`Module Guides`
			`=============`
docs: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`Pigweed is a collection of embedded-focused and embedded-related modules.`
docs: Various refinements ahead of launch This is a series of changes across the documentation to improve the overall first-user experience. Key changes: 1. New "Express setup" section in the "Getting Started" page. 2. Rename and reorder the left-hand menu bar components 3. Fix various copyright dates 4. Add presubmit animated gif to the pw_presubmit docs Change-Id: I22a75ace8c2be15a6e5890d6e1b3618a1d53eefa 2020-03-19 09:03:51 +00:00			`Modules may contain code from multiple languages, including C, C++, Go, Rust,`
			`Shell, Batch and Python.`
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
			`.. toctree::`
			`:maxdepth: 1`
docs: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`:glob:`
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
docs: Use glob to pull in docs.rst - Glob for */docs.rst in the modules.rst toctree to avoid needing to list each module's docs entry in three places. Globbing also automatically maintains alphabetical order. - Rename a few doc files to docs.rst. Change-Id: I4ff9a83184d326441b426afea6879a4a7b6740eb 2019-12-06 17:39:19 +00:00			`*/docs`