pw_bloat: Remove .rst from generated size reports
This change removes the .rst extension from the ReST size report files
generated by pw_bloat to prevent Sphinx from checking that they've been
added to a toctree. (Apparently including a file doesn't count as using
it.)
Change-Id: I4edc2db832bac0f370f563ac4f5c68692ad6f85e
diff --git a/pw_bloat/bloat.gni b/pw_bloat/bloat.gni
index db3f6dc..ed7b1bb 100644
--- a/pw_bloat/bloat.gni
+++ b/pw_bloat/bloat.gni
@@ -131,7 +131,7 @@
]
}
- _doc_rst_output = "$target_gen_dir/${target_name}.rst"
+ _doc_rst_output = "$target_gen_dir/${target_name}"
if (host_os == "win") {
# Bloaty is not yet packaged for Windows systems; display a message
@@ -290,7 +290,7 @@
not_needed("*")
not_needed(invoker, "*")
- _doc_rst_output = "$target_gen_dir/$target_name.rst"
+ _doc_rst_output = "$target_gen_dir/$target_name"
pw_python_script(target_name) {
metadata = {
pw_doc_sources = rebase_path([ _doc_rst_output ], root_build_dir)
diff --git a/pw_bloat/docs.rst b/pw_bloat/docs.rst
index efc16b2..bbbbb48 100644
--- a/pw_bloat/docs.rst
+++ b/pw_bloat/docs.rst
@@ -74,8 +74,8 @@
Documentation integration
=========================
Bloat reports are easy to add to documentation files. All ``pw_size_report``
-targets output a ``.rst`` file containing a tabular report card. This file
-can be imported directly into a documentation file using the ``include``
+targets output a file containing a tabular report card. This file can be
+imported directly into a ReST documentation file using the ``include``
directive.
For example, the ``simple_bloat_loop`` and ``simple_bloat_function`` size
@@ -85,18 +85,18 @@
Simple bloat loop example
^^^^^^^^^^^^^^^^^^^^^^^^^
- .. include:: examples/simple_bloat_loop.rst
+ .. include:: examples/simple_bloat_loop
Simple bloat function example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- .. include:: examples/simple_bloat_function.rst
+ .. include:: examples/simple_bloat_function
Resulting in this output:
Simple bloat loop example
^^^^^^^^^^^^^^^^^^^^^^^^^
-.. include:: examples/simple_bloat_loop.rst
+.. include:: examples/simple_bloat_loop
Simple bloat function example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. include:: examples/simple_bloat_function.rst
+.. include:: examples/simple_bloat_function
diff --git a/pw_bloat/py/bloat.py b/pw_bloat/py/bloat.py
index d55ec6a..8302fcf 100755
--- a/pw_bloat/py/bloat.py
+++ b/pw_bloat/py/bloat.py
@@ -194,7 +194,7 @@
report.append(out.diff())
rst = bloat_output.RstOutput(diffs)
- write_file(f'{args.target}.rst', rst.diff())
+ write_file(f'{args.target}', rst.diff())
complete_output = '\n'.join(report) + '\n'
write_file(f'{args.target}.txt', complete_output)
diff --git a/pw_docgen/py/docgen.py b/pw_docgen/py/docgen.py
index adf2c75..8be124c 100644
--- a/pw_docgen/py/docgen.py
+++ b/pw_docgen/py/docgen.py
@@ -132,7 +132,7 @@
# TODO(pwbug/164): Printing the header causes unicode problems on Windows.
# Disabled for now; re-enable once the root issue is fixed.
- #print(SCRIPT_HEADER)
+ # print(SCRIPT_HEADER)
copy_doc_tree(args)
# Flush all script output before running Sphinx.
diff --git a/pw_protobuf/decoding.rst b/pw_protobuf/decoding.rst
index 7c75a2e..d0dbea3 100644
--- a/pw_protobuf/decoding.rst
+++ b/pw_protobuf/decoding.rst
@@ -18,7 +18,7 @@
decode methods and a decode callback for a proto message containing each of the
protobuf field types.
-.. include:: size_report/decoder_full.rst
+.. include:: size_report/decoder_full
Incremental size report
@@ -28,4 +28,4 @@
fields to the decode callback to demonstrate the incremental cost of decoding
fields in a message.
-.. include:: size_report/decoder_incremental.rst
+.. include:: size_report/decoder_incremental
diff --git a/pw_string/docs.rst b/pw_string/docs.rst
index 6f1c791..37df397 100644
--- a/pw_string/docs.rst
+++ b/pw_string/docs.rst
@@ -45,7 +45,7 @@
to equivalent ``std::snprintf`` calls, there is no incremental code size cost to
using ``Format``.
-.. include:: format_size_report.rst
+.. include:: format_size_report
pw::StringBuilder
-----------------
@@ -66,7 +66,7 @@
call, but one or two StringBuilder appends may have a smaller code size impact
than a single ``snprintf`` call.
-.. include:: string_builder_size_report.rst
+.. include:: string_builder_size_report
Future work
^^^^^^^^^^^