Integrate bloat reports into docgen
This change updates the bloat script to output an RST version of its
report card table. Metadata is added to the bloat_report GN template
indicating its RST output, allowing it to be listed as a dependency of
pw_doc_group targets.
Change-Id: I3f098d352856a9dd8688bac44e3b60ddbb97a3a6
diff --git a/pw_bloat/bloat.rst b/pw_bloat/bloat.rst
new file mode 100644
index 0000000..3e72a1f
--- /dev/null
+++ b/pw_bloat/bloat.rst
@@ -0,0 +1,31 @@
+.. _chapter-bloat:
+
+.. default-domain:: cpp
+
+.. highlight:: sh
+
+-----
+Bloat
+-----
+The bloat module provides tools to generate size report cards for output
+binaries.
+
+.. TODO(frolv): Explain how bloat works and how to set it up.
+
+Documentation integration
+=========================
+Bloat reports are easy to add to documentation files. All ``bloat_report``
+targets output a ``.rst`` file containing a tabular report card. This file
+can be imported directly into a documentation file using the ``include``
+directive.
+
+For example, the ``simple_bloat`` bloat report under ``//pw_bloat/examples``
+is imported into this file as follows:
+
+.. code:: rst
+
+ .. include:: examples/simple_bloat.rst
+
+Resulting in this output:
+
+.. include:: examples/simple_bloat.rst