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.