third_party.pigweed.src/targets/docs/target_docs.rst

.. _target-docs:

----
docs
----
The Pigweed docs target assembles Pigweed's reStructuredText and markdown
documentation into a collection of HTML pages.

Building
========
To build for this target, invoke ninja with the top-level "docs" group as the
target to build.

.. code:: sh

  $ gn gen out
  $ ninja -C out docs

Output
======
Final HTML documentation will be placed in the ``out/docs/gen/docs/html``
directory of the build.
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			`.. _target-docs:`
Docs: Add target docs Adds target docs for the `docs` and `host` builds. Also includes a few other documentation updates. Change-Id: Icc973d6d51707c79b7c506d89c8975023e274ef2 2020-03-19 19:13:36 +00:00
			`----`
			`docs`
			`----`
			`The Pigweed docs target assembles Pigweed's reStructuredText and markdown`
			`documentation into a collection of HTML pages.`

			`Building`
			`========`
pw_watch: Update syntax for pw_watch Updates syntax for using pw_watch in a few other locations. Change-Id: I599fc3cb552c75e9f546447556fb756633093391 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/13804 Reviewed-by: Ewout van Bekkum <ewout@google.com> Reviewed-by: Keir Mierle <keir@google.com> Commit-Queue: Armando Montanez <amontanez@google.com> 2020-07-13 21:35:16 +00:00			`To build for this target, invoke ninja with the top-level "docs" group as the`
			`target to build.`
Docs: Add target docs Adds target docs for the `docs` and `host` builds. Also includes a few other documentation updates. Change-Id: Icc973d6d51707c79b7c506d89c8975023e274ef2 2020-03-19 19:13:36 +00:00
			`.. code:: sh`

pw_watch: Update target/directory syntax Since specifying which Ninja targets to build is now just as important as which directory to build, update pw_watch's command line syntax to better support specifying build targets and directories. Before pw watch out#host#docs another/build/dir#stm32f429i After pw watch out host docs --build-directory another/build/dir stm32f429i Change-Id: Ic41dc6ce277ed240402877e9d875e8228aaac48b 2020-06-17 22:04:43 +00:00			`$ gn gen out`
			`$ ninja -C out docs`
Docs: Add target docs Adds target docs for the `docs` and `host` builds. Also includes a few other documentation updates. Change-Id: Icc973d6d51707c79b7c506d89c8975023e274ef2 2020-03-19 19:13:36 +00:00
			`Output`
			`======`
pw_watch: Update target/directory syntax Since specifying which Ninja targets to build is now just as important as which directory to build, update pw_watch's command line syntax to better support specifying build targets and directories. Before pw watch out#host#docs another/build/dir#stm32f429i After pw watch out host docs --build-directory another/build/dir stm32f429i Change-Id: Ic41dc6ce277ed240402877e9d875e8228aaac48b 2020-06-17 22:04:43 +00:00			Final HTML documentation will be placed in the ``out/docs/gen/docs/html``
			`directory of the build.`