mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 05:41:06 +00:00
f9fb90f299
- 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>
23 lines
433 B
ReStructuredText
23 lines
433 B
ReStructuredText
.. _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.
|