aboutsummaryrefslogtreecommitdiff
path: root/targets/docs/target_docs.rst
blob: 92ad55e8ba62333b00b27c82db845ef09e783706 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
.. _target-docs:

----
docs
----
The Pigweed docs target assembles Pigweed's reStructuredText and markdown
documentation into a collection of HTML pages.

The docs target uses the :ref:`target-stm32f429i-disc1` toolchain with C++20 for
size reports.

Building
========
To build for this target, invoke ninja with the top-level "docs" group as the
target to build.

.. code-block:: 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.