Skip to content

Commit 4a020ab

Browse files
🍱 Add ER Diagram
This changes adds automatic overall ER Diagram generation to the project. It should work seamlessly for local and github deployments. It's possible there could be a naming conflict with other generated text, eg, if there was a slot called "erdiagram".
1 parent 104d68e commit 4a020ab

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/schema/include_access_model.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1754,5 +1754,5 @@ metamodel_version: 1.7.0
17541754
source_file: include_access_model.yaml
17551755
source_file_date: '2025-11-12T10:52:41'
17561756
source_file_size: 24481
1757-
generation_date: '2025-11-12T18:16:29'
1757+
generation_date: '2025-11-12T18:29:57'
17581758

justfile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,14 @@ lint:
9494

9595
# Generate md documentation for the schema
9696
[group('model development')]
97-
gen-doc: _gen-yaml
97+
gen-doc: _gen-yaml _gen-erd
9898
uv run gen-doc {{gen_doc_args}} -d {{docdir}} {{source_schema_path}}
9999

100+
# Generate erd for the overall schema and add it to the docs
101+
[group('model development')]
102+
_gen-erd:
103+
uv run gen-erdiagram {{source_schema_path}} > {{docdir}}/erdiagram.md
104+
100105
# Build docs and run test server
101106
[group('model development')]
102107
testdoc: gen-doc _serve

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ watch:
2525
- src/include_access_model/schema
2626

2727
nav:
28-
- Home: index.md
28+
# - Home: index.md
2929
- Schema: elements/index.md
30+
- ER Diagram: elements/erdiagram.md
3031
- About: about.md
3132

3233
exclude_docs: |

src/include_access_model/datamodel/include_access_model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Auto generated from include_access_model.yaml by pythongen.py version: 0.0.1
2-
# Generation date: 2025-11-12T18:15:09
2+
# Generation date: 2025-11-12T18:36:02
33
# Schema: include-access-model
44
#
55
# id: https://includedcc.org/include-access-model

0 commit comments

Comments
 (0)