Add entity relation diagram for the catalog database (#665)

* add erdiagram * Add sphinx mermaid dependency * Make mermaid a directive Also add explicit target for Catalog Database header --------- Co-authored-by: Padraic Shafer <[email protected]>
bluesky · Mar 8, 2024 · 4a75e6b · 4a75e6b
1 parent 63b583b
commit 4a75e6b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -46,6 +46,7 @@
     "sphinx_copybutton",
     "myst_parser",
     "sphinxcontrib.jquery",
+    "sphinxcontrib.mermaid",
 ]
 
 # Configuration options for plot_directive. See:

diff --git a/docs/source/explanations/architecture.md b/docs/source/explanations/architecture.md
@@ -124,3 +124,17 @@ providing a writable data store, the Catalog is used.
 [OpenAPI]: https://www.openapis.org/
 [Pydantic]: https://docs.pydantic.dev/
 [content negotiation]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation
+
+(catalog-database)=
+### Catalog Database
+
+```{mermaid}
+erDiagram
+    nodes ||--o{  data_sources : has
+    data_sources ||--o{  data_source_asset_association : has
+    data_source_asset_association }|--|{  assets : has
+    data_sources }|--||   structure : has
+    nodes ||--o{  revisions : has
+    alembic_version
+
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -159,6 +159,7 @@ dev = [
     "myst-parser",
     "numpydoc",
     "sphinx-click",
+    "sphinxcontrib-mermaid",
     "sphinx-copybutton",
     "sphinx_rtd_theme",
 ]