Install sphinxcontrib-plantuml

.gitignore

@@ -1 +1,2 @@
+.venv
 _build

README.md

@@ -1 +1,5 @@
 # C4
+
+## TODO
+
+- Try https://github.com/sphinx-contrib/kroki.

a3m.rst

@@ -2,4 +2,23 @@
 a3m
 ===
 
-Hi there!
+Class diagram:
+
+.. uml::
+   :caption: A caption with **bold** text.
+
+   Foo <|-- Bar
+
+Sequence diagram:
+
+.. uml::
+
+   Alice -> Bob: Hello!
+   Alice <- Bob: Hi!
+
+C4 diagram:
+
+.. uml::
+
+    !include <C4/C4_Context>
+    Person(user, "C4 fans", "Hello to Sphinx!")

conf.py

@@ -31,6 +31,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinxcontrib.plantuml',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -39,7 +40,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -52,4 +53,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']

requirements.in

@@ -0,0 +1,3 @@
+sphinx~=7.2.6
+sphinxcontrib-plantuml~=0.27
+pip-tools~=7.3.0

requirements.txt

@@ -0,0 +1,73 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.13.1
+    # via sphinx
+build==1.0.3
+    # via pip-tools
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.3.1
+    # via requests
+click==8.1.7
+    # via pip-tools
+docutils==0.20.1
+    # via sphinx
+idna==3.4
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via sphinx
+markupsafe==2.1.3
+    # via jinja2
+packaging==23.2
+    # via
+    #   build
+    #   sphinx
+pip-tools==7.3.0
+    # via -r requirements.in
+pygments==2.16.1
+    # via sphinx
+pyproject-hooks==1.0.0
+    # via build
+requests==2.31.0
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==7.2.6
+    # via
+    #   -r requirements.in
+    #   sphinxcontrib-applehelp
+    #   sphinxcontrib-devhelp
+    #   sphinxcontrib-htmlhelp
+    #   sphinxcontrib-plantuml
+    #   sphinxcontrib-qthelp
+    #   sphinxcontrib-serializinghtml
+sphinxcontrib-applehelp==1.0.7
+    # via sphinx
+sphinxcontrib-devhelp==1.0.5
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.4
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-plantuml==0.27
+    # via -r requirements.in
+sphinxcontrib-qthelp==1.0.6
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.9
+    # via sphinx
+urllib3==2.0.7
+    # via requests
+wheel==0.41.3
+    # via pip-tools
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools