pw_docgen: Add sphinxcontrib-mermaid
This allows for embedding mermaid diagrams in rst files. It uses
https://github.com/mgaitan/sphinxcontrib-mermaid
For example:
.. mermaid::
sequenceDiagram
participant Alice
participant Bob
Alice->John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
Change-Id: I04ee218cfb6e3a6cfdd3f3e189a5a632d5628bee
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/44021
Reviewed-by: Rob Mohr <[email protected]>
Commit-Queue: Anthony DiGirolamo <[email protected]>
diff --git a/pw_docgen/docs.rst b/pw_docgen/docs.rst
index 041893e..fcb028e 100644
--- a/pw_docgen/docs.rst
+++ b/pw_docgen/docs.rst
@@ -38,6 +38,20 @@
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://www.sphinx-doc.org/en/master
+There are additonal Sphinx plugins used for rendering diagrams within
+reStructuredText files including:
+
+* `Blockdiag <http://blockdiag.com/>`_ via these sphinxcontrib packages:
+
+ * `sphinxcontrib-blockdiag
+ <https://pypi.org/project/sphinxcontrib-blockdiag/>`_
+ * `sphinxcontrib-actdiag <https://pypi.org/project/sphinxcontrib-actdiag/>`_
+ * `sphinxcontrib-nwdiag <https://pypi.org/project/sphinxcontrib-nwdiag/>`_
+ * `sphinxcontrib-seqdiag <https://pypi.org/project/sphinxcontrib-seqdiag/>`_
+
+* `mermaid <https://mermaid-js.github.io/>`_ via the `sphinxcontrib-mermaid
+ <https://pypi.org/project/sphinxcontrib-mermaid/>`_ package.
+
Documentation source and asset files are placed alongside code within a module
and registered as a ``pw_docgen_group`` target within a ``BUILD.gn`` file. These
groups become available for import within a special documentation generation
