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

   1 .. _target-docs:
   2
   3 ----
   4 docs
   5 ----
   6 The Pigweed docs target assembles Pigweed's reStructuredText and markdown
   7 documentation into a collection of HTML pages.
   8
   9 Building
  10 ========
  11 To build for this target, invoke ninja with the top-level "docs" group as the
  12 target to build.
  13
  14 .. code:: sh
  15
  16   $ gn gen out
  17   $ ninja -C out docs
  18
  19 Output
  20 ======
  21 Final HTML documentation will be placed in the ``out/docs/gen/docs/html``
  22 directory of the build.