mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
7366d5ae79
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
27 lines
500 B
ReStructuredText
27 lines
500 B
ReStructuredText
.. _chapter-docs:
|
|
|
|
.. default-domain:: cpp
|
|
|
|
.. highlight:: sh
|
|
|
|
----
|
|
docs
|
|
----
|
|
The Pigweed docs target assembles Pigweed's reStructuredText and markdown
|
|
documentation into a collection of HTML pages.
|
|
|
|
Building
|
|
========
|
|
To build for this target, change the ``pw_target_config`` GN build arg to point
|
|
to this target's configuration file.
|
|
|
|
.. 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.
|