xref: /aosp_15_r20/external/pigweed/targets/docs/target_docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _target-docs:
2
3----
4docs
5----
6The Pigweed docs target assembles Pigweed's reStructuredText and markdown
7documentation into a collection of HTML pages.
8
9The docs target uses the :ref:`target-stm32f429i-disc1` toolchain with C++20 for
10size reports.
11
12Building
13========
14To build for this target, invoke ninja with the top-level "docs" group as the
15target to build.
16
17.. code-block:: sh
18
19   $ gn gen out
20   $ ninja -C out docs
21
22Output
23======
24Final HTML documentation will be placed in the ``out/docs/gen/docs/html``
25directory of the build.
26