Lines Matching +full:python3 +full:- +full:docutils
1 .. _module-pw_docgen:
6 .. pigweed-module::
9 ``pw_docgen`` provides tools to generate documentation for Pigweed-based
16 --------
18 --------
19 Pigweed-based projects typically use a subset of Pigweed's modules and add their
20 own product-specific modules on top of that, which may have product-specific
29 depend on other build targets, such as :ref:`report cards <module-pw_bloat>` for
40 -----------------
42 -----------------
46 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
47 .. inclusive-language: ignore
48 .. _Sphinx: http://www.sphinx-doc.org/en/master
53 * `mermaid <https://mermaid-js.github.io/>`_ via the `sphinxcontrib-mermaid
54 <https://pypi.org/project/sphinxcontrib-mermaid/>`_ package.
67 ------------
88 .. code-block::
92 inputs = [ "face-with-tears-of-joy-emoji.svg" ]
98 ----------
111 * ``index``: Path to the top-level ``index.rst`` file.
114 * ``python_metadata_deps``: Python-related dependencies that are only used as
116 documentation generation. This should rarely be used by non-Pigweed code.
120 .. code-block::
132 ------------------------
140 .. code-block::
159 .. code-block::
177 top-level ``index.rst`` file's imports; they must start from the project's build
181 ---------------------
182 ``pw_docgen`` includes a web server that serves locally-generated documentation
183 at ``pw_docgen.docserver``. It supports hot-reloading, so the rendered docs in
187 will be run via :ref:`module-pw_watch`.
189 -----------------------------
191 -----------------------------
195 This module houses Pigweed-specific extensions for the Sphinx documentation
200 See :ref:`docs-contrib-docs-modules-metadata`.
203 ---------------------------
219 .. code-block:: console
221 grep '<link rel="canonical' out/docs/gen/docs/html/* -R
226 ----------------
238 -------------------------------------
244 .. code-block::
249 (``environment/pigweed-venv/lib/python3.8/site-packages/pw_docgen``):
251 .. code-block::
253 ninja -C out python.install
257 .. code-block::
260 …sphinx-build -W -b html -d docs/gen/docs/help docs/gen/docs/pw_docgen_tree docs/gen/docs/html -v -…