📝 added mermaid support to docs

.gitignore

@@ -35,4 +35,7 @@ MANIFEST
 .history/
 
 # tweet_generator example
-examples/tweet_generator/*.ttf
+examples/tweet_generator/*.ttf
+
+# sphinxcontrib-mermaid output file
+out.svg

docs/conf.py

@@ -44,7 +44,8 @@
     'exception_hierarchy',
     'attributetable',
     'silence',
-    'sphinxcontrib_trio'
+    'sphinxcontrib_trio',
+    'sphinxcontrib.mermaid',
 ]
 
 add_module_names = False
@@ -55,6 +56,8 @@
 
 set_type_checking_flag = True
 
+mermaid_output_format = 'raw'
+
 resource_links = {
     'discord': 'https://discord.gg/et54DgVjMX',
     'issues': 'https://github.com/Pincer-org/Pincer/issues',

docs/requirements.txt

@@ -1,3 +1,4 @@
 furo
-sphinxcontrib-trio
 sphinx-design
+sphinxcontrib-trio
+sphinxcontrib-mermaid