You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
23 lines
433 B
23 lines
433 B
7 months ago
|
.. _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.
|