third_party.pigweed.src/docs/index.rst

.. _chapter-home:

.. highlight:: sh

.. mdinclude:: README.md

.. toctree::
  :maxdepth: 1
  :hidden:

  Home <self>
  docs/embedded_cpp_guide
  docs/style_guide
  targets
  modules
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-02 21:11:41 +00:00			`.. _chapter-home:`
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-15 01:22:08 +00:00
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-02 21:11:41 +00:00			`.. highlight:: sh`

			`.. mdinclude:: README.md`
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-15 01:22:08 +00:00
			`.. toctree::`
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			`:maxdepth: 1`
			`:hidden:`
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-15 01:22:08 +00:00
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 02:04:31 +00:00			`Home <self>`
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/embedded_cpp_guide`
			`docs/style_guide`
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 18:51:50 +00:00			`targets`
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			`modules`