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