diff --git a/docs/source/conf.py b/docs/source/conf.py index 214a3b40d..6044f3de8 100644 --- 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 index 9f2045c7c..3eb233e9d 100644 --- 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 index 5d9ee752c..f82483404 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -159,6 +159,7 @@ dev = [ "myst-parser", "numpydoc", "sphinx-click", + "sphinxcontrib-mermaid", "sphinx-copybutton", "sphinx_rtd_theme", ]