drf-to-mkdoc 0.2.4__tar.gz → 0.3.0__tar.gz

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.2.4
+Version: 0.3.0
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>
@@ -55,6 +55,7 @@ Generate beautiful, interactive Markdown API documentation from Django REST Fram
 
 - **Zero-hassle docs**: Beautiful, always-in-sync API docs straight from your codebase
 - **Model deep dive**: Auto-generated model pages with fields, relationships, and choices
+- **ER Diagrams**: Entity-Relationship diagrams showing model relationships
 - **Lightning-fast discovery**: Interactive endpoint index with powerful filters and search
 - **Try-it-out**: Interactive API testing directly in the documentation with request/response examples
 - **AI-powered**: Optional AI-generated documentation with custom field generators(Wait for it...)
@@ -96,8 +97,9 @@ DRF_TO_MKDOC = {
         'inventory',
     ],
     # Optional: Override default paths
-    # 'DOCS_DIR': 'docs',
+    # 'DOCS_DIR': 'docs',  # Base directory for all generated docs
     # 'CONFIG_DIR': 'docs/configs',
+    # 'ER_DIAGRAMS_DIR': 'er_diagrams',  # Directory for ER diagrams (relative to DOCS_DIR)
     # 'MODEL_DOCS_FILE': 'docs/model-docs.json',
     # 'DOC_CONFIG_FILE': 'docs/configs/doc_config.json',
     # 'CUSTOM_SCHEMA_FILE': 'docs/configs/custom_schema.json',
@@ -112,6 +114,8 @@ DRF_TO_MKDOC = {
 
 2. **Create MkDocs configuration**:  
    Copy the [`docs/mkdocs.yml`](docs/mkdocs.yml) file to your project root and customize it as needed.
+   
+   **Note**: If you change the `ER_DIAGRAMS_DIR` setting, update the navigation path in `mkdocs.yml` accordingly.
 
 3. **Build documentation**:
 
@@ -124,8 +128,9 @@ python manage.py build_docs --settings=docs_settings
 The `DRF_TO_MKDOC` setting supports several configuration options:
 
 - **`DJANGO_APPS`** (required): List of Django app names to process
-- **`DOCS_DIR`**: Directory where docs will be generated (default: `docs`)
+- **`DOCS_DIR`**: Base directory where docs will be generated (default: `docs`)
 - **`CONFIG_DIR`**: Directory for configuration files (default: `docs/configs`)
+- **`ER_DIAGRAMS_DIR`**: Directory for ER diagrams (default: `er_diagrams`, relative to `DOCS_DIR`)
 - **`FIELD_GENERATORS`**: Custom field value generators for better examples
 - **`ENABLE_AI_DOCS`**: Enable AI-powered documentation features (default: `False`)
 - **`PATH_PARAM_SUBSTITUTE_FUNCTION`**: Custom function for path parameter substitution
@@ -153,6 +158,12 @@ See a detailed overview of generated files in `docs/structure.md` and a feature
 - **Floating action button**: Easy access to testing interface
 - **Multiple examples**: Support for both empty and populated response examples
 
+### 📊 Entity-Relationship Diagrams
+- **Visual model relationships**: Interactive ER diagrams showing all model connections
+- **App-specific views**: Detailed diagrams for each Django app with field information
+- **Mermaid-powered**: Clean, professional diagrams with zoom and navigation controls
+- **Auto-generated**: Automatically created from your Django model relationships
+
 ### 🤖 AI-Powered Documentation
 - **Custom field generators**: Define custom value generators for specific fields
 - **AI documentation**: Optional AI-generated documentation with context analysis
@@ -233,6 +244,10 @@ drf-to-mkdoc/
 │       ├── model_list_generator.py
 │       └── schema.py
 ├── docs/                      # Generated documentation
+│   ├── endpoints/             # API endpoint documentation
+│   ├── models/                # Model documentation
+│   ├── er_diagrams/           # Entity-Relationship diagrams
+│   └── configs/               # Configuration files
 ├── pyproject.toml            # Project configuration
 └── README.md
 ```
@@ -251,6 +266,7 @@ To avoid committing generated files to your repository, add the following to you
 # Documentation
 /docs/endpoints/
 /docs/models/
+/docs/er_diagrams/
 /docs/configs/doc-schema.yaml
 
 # Build artifacts
@@ -287,6 +303,10 @@ your-project/
 ├── docs_settings.py     # Documentation-specific settings
 ├── mkdocs.yml          # MkDocs configuration
 ├── docs/               # Generated documentation (gitignored)
+│   ├── endpoints/      # API endpoint docs
+│   ├── models/         # Model documentation
+│   ├── er_diagrams/    # ER diagrams
+│   └── configs/        # Configuration files
 └── site/               # Built site (gitignored)
 ```
 

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/README.md

@@ -6,6 +6,7 @@ Generate beautiful, interactive Markdown API documentation from Django REST Fram
 
 - **Zero-hassle docs**: Beautiful, always-in-sync API docs straight from your codebase
 - **Model deep dive**: Auto-generated model pages with fields, relationships, and choices
+- **ER Diagrams**: Entity-Relationship diagrams showing model relationships
 - **Lightning-fast discovery**: Interactive endpoint index with powerful filters and search
 - **Try-it-out**: Interactive API testing directly in the documentation with request/response examples
 - **AI-powered**: Optional AI-generated documentation with custom field generators(Wait for it...)
@@ -47,8 +48,9 @@ DRF_TO_MKDOC = {
         'inventory',
     ],
     # Optional: Override default paths
-    # 'DOCS_DIR': 'docs',
+    # 'DOCS_DIR': 'docs',  # Base directory for all generated docs
     # 'CONFIG_DIR': 'docs/configs',
+    # 'ER_DIAGRAMS_DIR': 'er_diagrams',  # Directory for ER diagrams (relative to DOCS_DIR)
     # 'MODEL_DOCS_FILE': 'docs/model-docs.json',
     # 'DOC_CONFIG_FILE': 'docs/configs/doc_config.json',
     # 'CUSTOM_SCHEMA_FILE': 'docs/configs/custom_schema.json',
@@ -63,6 +65,8 @@ DRF_TO_MKDOC = {
 
 2. **Create MkDocs configuration**:  
    Copy the [`docs/mkdocs.yml`](docs/mkdocs.yml) file to your project root and customize it as needed.
+   
+   **Note**: If you change the `ER_DIAGRAMS_DIR` setting, update the navigation path in `mkdocs.yml` accordingly.
 
 3. **Build documentation**:
 
@@ -75,8 +79,9 @@ python manage.py build_docs --settings=docs_settings
 The `DRF_TO_MKDOC` setting supports several configuration options:
 
 - **`DJANGO_APPS`** (required): List of Django app names to process
-- **`DOCS_DIR`**: Directory where docs will be generated (default: `docs`)
+- **`DOCS_DIR`**: Base directory where docs will be generated (default: `docs`)
 - **`CONFIG_DIR`**: Directory for configuration files (default: `docs/configs`)
+- **`ER_DIAGRAMS_DIR`**: Directory for ER diagrams (default: `er_diagrams`, relative to `DOCS_DIR`)
 - **`FIELD_GENERATORS`**: Custom field value generators for better examples
 - **`ENABLE_AI_DOCS`**: Enable AI-powered documentation features (default: `False`)
 - **`PATH_PARAM_SUBSTITUTE_FUNCTION`**: Custom function for path parameter substitution
@@ -104,6 +109,12 @@ See a detailed overview of generated files in `docs/structure.md` and a feature
 - **Floating action button**: Easy access to testing interface
 - **Multiple examples**: Support for both empty and populated response examples
 
+### 📊 Entity-Relationship Diagrams
+- **Visual model relationships**: Interactive ER diagrams showing all model connections
+- **App-specific views**: Detailed diagrams for each Django app with field information
+- **Mermaid-powered**: Clean, professional diagrams with zoom and navigation controls
+- **Auto-generated**: Automatically created from your Django model relationships
+
 ### 🤖 AI-Powered Documentation
 - **Custom field generators**: Define custom value generators for specific fields
 - **AI documentation**: Optional AI-generated documentation with context analysis
@@ -184,6 +195,10 @@ drf-to-mkdoc/
 │       ├── model_list_generator.py
 │       └── schema.py
 ├── docs/                      # Generated documentation
+│   ├── endpoints/             # API endpoint documentation
+│   ├── models/                # Model documentation
+│   ├── er_diagrams/           # Entity-Relationship diagrams
+│   └── configs/               # Configuration files
 ├── pyproject.toml            # Project configuration
 └── README.md
 ```
@@ -202,6 +217,7 @@ To avoid committing generated files to your repository, add the following to you
 # Documentation
 /docs/endpoints/
 /docs/models/
+/docs/er_diagrams/
 /docs/configs/doc-schema.yaml
 
 # Build artifacts
@@ -238,6 +254,10 @@ your-project/
 ├── docs_settings.py     # Documentation-specific settings
 ├── mkdocs.yml          # MkDocs configuration
 ├── docs/               # Generated documentation (gitignored)
+│   ├── endpoints/      # API endpoint docs
+│   ├── models/         # Model documentation
+│   ├── er_diagrams/    # ER diagrams
+│   └── configs/        # Configuration files
 └── site/               # Built site (gitignored)
 ```
 

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/docs/mkdocs.yml

@@ -37,6 +37,7 @@ plugins:
 nav:
   - Home: index.md
   - Models: models/
+  - ER Diagrams: er_diagrams/  # ER_DIAGRAMS_DIR setting
   - API Endpoints: endpoints/
 
 markdown_extensions:

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/drf_to_mkdoc/conf/defaults.py

@@ -2,6 +2,7 @@ DEFAULTS = {
     # Path configurations with defaults
     "DOCS_DIR": "docs",  # Directory where docs will be generated
     "CONFIG_DIR": "docs/configs",  # Directory for configuration files
+    "ER_DIAGRAMS_DIR": "er_diagrams",  # Directory for ER diagrams (relative to DOCS_DIR)
     "MODEL_DOCS_FILE": "docs/model-docs.json",  # Path to model documentation JSON file
     "DOC_CONFIG_FILE": "docs/configs/doc_config.json",  # Path to documentation configuration file
     "CUSTOM_SCHEMA_FILE": "docs/configs/custom_schema.json",  # Path to custom schema file

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/drf_to_mkdoc/conf/settings.py

@@ -22,6 +22,7 @@ class DRFToMkDocSettings:
 
     path_settings = {
         "CONFIG_DIR",
+        "ER_DIAGRAMS_DIR",
         "MODEL_DOCS_FILE",
         "DOC_CONFIG_FILE",
         "CUSTOM_SCHEMA_FILE",

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/drf_to_mkdoc/management/commands/build_model_docs.py

@@ -4,6 +4,7 @@ from django.core.management.base import BaseCommand
 
 from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
 from drf_to_mkdoc.utils.commons.file_utils import load_json_data
+from drf_to_mkdoc.utils.er_diagram_generator import generate_er_diagrams
 from drf_to_mkdoc.utils.model_detail_generator import generate_model_docs
 from drf_to_mkdoc.utils.model_list_generator import create_models_index
 
@@ -42,9 +43,17 @@ class Command(BaseCommand):
         self.stdout.write("📋 Generating model documentation...")
 
         try:
+            # Generate model detail pages
             generate_model_docs(models_data)
+            self.stdout.write(self.style.SUCCESS("✅ Model detail pages generated"))
+
+            # Generate ER diagrams
+            generate_er_diagrams(models_data, docs_dir)
+            self.stdout.write(self.style.SUCCESS("✅ ER diagrams generated"))
+
+            # Create models index page
             create_models_index(models_data, docs_dir)
-            self.stdout.write(self.style.SUCCESS("✅ Model documentation generated"))
+            self.stdout.write(self.style.SUCCESS("✅ Models index page generated"))
         except Exception as e:
             self.stdout.write(self.style.WARNING(f"⚠️  Failed to generate model docs: {e}"))
             raise

drf_to_mkdoc-0.3.0/drf_to_mkdoc/templates/er_diagrams/app.html

@@ -0,0 +1,26 @@
+# {{ app_name|title|cut:"_"|safe }} Models
+
+```mermaid
+erDiagram
+{% for entity in app_entities %}
+    {{ entity.model_name }} {
+{% for field in entity.fields %}
+        {{ field.name }} {{ field.type }}{% if field.is_pk %} "PK"{% elif field.nullable %} "NULLABLE"{% endif %}
+{% endfor %}
+    }
+{% endfor %}
+{% for entity in related_entities %}
+    {{ entity.model_name }} {
+        id AutoField "PK"
+    }
+{% endfor %}
+{% for relationship in relationships %}
+    {{ relationship.source_model }} {{ relationship.type }} {{ relationship.target_model }} : "{{ relationship.description }}"
+{% endfor %}
+
+```
+
+## Models
+
+{% for entity in app_entities %}- [{{ entity.model_name }}](../../models/{{ entity.app_name }}/{{ entity.table_name }}/)
+{% endfor %}

drf_to_mkdoc-0.3.0/drf_to_mkdoc/templates/er_diagrams/index.html

@@ -0,0 +1,14 @@
+# Entity-Relationship Diagrams
+
+This section contains Entity-Relationship (ER) diagrams for all Django models in the system.
+
+## [Complete System Diagram](main.md)
+
+View the complete ER diagram showing all models and their relationships.
+
+## Application Diagrams
+
+| Application | Models 
+|------------|--------|
+{% for app in apps %}| [{{ app.name|title|cut:"_"|safe }}]({{ app.name }}.md) | {{ app.model_count }} |
+{% endfor %}

drf_to_mkdoc-0.3.0/drf_to_mkdoc/templates/er_diagrams/main.html

@@ -0,0 +1,22 @@
+# Complete Entity-Relationship Diagram
+
+```mermaid
+erDiagram
+{% for entity in entities %}
+    {{ entity.model_name }} {
+{% for field in entity.fields %}
+        {{ field.name }} {{ field.type }}{% if field.is_pk %} "PK"{% elif field.nullable %} "NULLABLE"{% endif %}
+{% endfor %}
+    }
+{% endfor %}
+{% for relationship in relationships %}
+    {{ relationship.source_model }} {{ relationship.type }} {{ relationship.target_model }} : "{{ relationship.description }}"
+{% endfor %}
+
+```
+
+<div class="er-diagram-controls">
+  <button class="zoom-in">Zoom In</button>
+  <button class="zoom-out">Zoom Out</button>
+  <button class="reset-zoom">Reset</button>
+</div>

drf_to_mkdoc-0.3.0/drf_to_mkdoc/utils/er_diagram_generator.py

@@ -0,0 +1,230 @@
+from pathlib import Path
+from typing import Any
+
+from django.template.loader import render_to_string
+
+from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
+
+from .commons.file_utils import write_file
+
+
+def _get_relationship_type_and_description(rel_type_class: str) -> tuple[str, str] | None:
+    """Map Django relationship type to Mermaid ER diagram syntax and description."""
+    mapping = {
+        "ForeignKey": ("}o--||", "many to 1"),
+        "OneToOneField": ("||--||", "1 to 1"),
+        "OneToOneRel": ("||--||", "1 to 1"),
+        "ManyToManyField": ("}o--o{", "many to many"),
+        "ManyToManyRel": ("}o--o{", "many to many"),
+        "ManyToOneRel": ("||--o{", "1 to many"),
+    }
+    return mapping.get(rel_type_class)
+
+
+def _create_entity_from_model(
+    app_name: str, model_name: str, model_info: dict[str, Any], include_fields: bool = False
+) -> dict[str, Any]:
+    """Create entity dictionary from model data, optionally including field details."""
+    table_name = model_info.get("table_name", model_name)
+    entity_id = f"{app_name}__{table_name}"
+
+    entity = {
+        "id": entity_id,
+        "app_name": app_name,
+        "model_name": model_name,
+        "table_name": table_name,
+        "fields": [],
+    }
+
+    if include_fields:
+        fields = []
+        has_pk = False
+
+        for field_name, field_info in model_info.get("column_fields", {}).items():
+            field_type = field_info.get("type", "")
+            is_pk = field_info.get("primary_key", False)
+            nullable = field_info.get("null", False) or field_info.get("blank", False)
+
+            fields.append({
+                "name": field_name,
+                "type": field_type,
+                "is_pk": is_pk,
+                "nullable": nullable
+            })
+
+            if is_pk:
+                has_pk = True
+
+        if not has_pk:
+            fields.insert(0, {
+                "name": "id",
+                "type": "AutoField",
+                "is_pk": True,
+                "nullable": False
+            })
+
+        entity["fields"] = fields
+
+    return entity
+
+
+def _process_model_relationships(
+    source_entity_id: str,
+    source_model_name: str,
+    model_info: dict[str, Any],
+    all_models_data: dict[str, Any]
+) -> list[dict[str, Any]]:
+    """Extract and process model relationships, returning Mermaid-compatible relationship data."""
+    relationships = []
+
+    for rel_name, rel_info in model_info.get("relationships", {}).items():
+        if not isinstance(rel_info, dict):
+            continue
+
+        related_model_label = rel_info.get("related_model", "")
+        if not related_model_label or "." not in related_model_label:
+            continue
+
+        target_app, target_model = related_model_label.split(".", 1)
+
+        target_table_name = rel_info.get("table_name", target_model.lower())
+        if target_app in all_models_data and target_model in all_models_data[target_app]:
+            target_table_name = all_models_data[target_app][target_model].get(
+                "table_name", target_model.lower()
+            )
+
+        target_entity_id = f"{target_app}__{target_table_name}"
+
+        rel_type_class = rel_info.get("type", "")
+        type_info = _get_relationship_type_and_description(rel_type_class)
+        if not type_info:
+            continue
+
+        rel_type, description = type_info
+
+        relationships.append({
+            "source": source_entity_id,
+            "target": target_entity_id,
+            "source_model": source_model_name,
+            "target_model": target_model,
+            "type": rel_type,
+            "label": rel_name,
+            "description": description,
+        })
+
+    return relationships
+
+
+def generate_er_diagrams(models_data: dict[str, Any], docs_dir: Path) -> None:
+    """Generate main ER diagram, app-specific diagrams, and index page from model data."""
+    generate_main_er_diagram(models_data, docs_dir)
+
+    for app_name, models in models_data.items():
+        if not isinstance(models, dict):
+            continue
+        generate_app_er_diagram(app_name, models, models_data, docs_dir)
+
+    generate_er_diagrams_index(models_data, docs_dir)
+
+
+def generate_main_er_diagram(models_data: dict[str, Any], _docs_dir: Path) -> None:
+    """Create main ER diagram showing all models and their relationships."""
+    entities = []
+    relationships = []
+
+    for app_name, models in models_data.items():
+        if not isinstance(models, dict):
+            continue
+
+        for model_name, model_info in models.items():
+            if not isinstance(model_info, dict):
+                continue
+
+            entity = _create_entity_from_model(app_name, model_name, model_info, include_fields=False)
+            entities.append(entity)
+
+            model_relationships = _process_model_relationships(
+                entity["id"], model_name, model_info, models_data
+            )
+            relationships.extend(model_relationships)
+
+    content = render_to_string(
+        "er_diagrams/main.html", {"entities": entities, "relationships": relationships}
+    )
+
+    write_file(f"{drf_to_mkdoc_settings.ER_DIAGRAMS_DIR}/main.md", content)
+
+
+def generate_app_er_diagram(
+    app_name: str, app_models: dict[str, Any], all_models_data: dict[str, Any], _docs_dir: Path
+) -> None:
+    """Create app-specific ER diagram with detailed fields and related models."""
+    app_entities = []
+    related_entities = []
+    relationships = []
+    related_entity_ids = set()
+
+    for model_name, model_info in app_models.items():
+        if not isinstance(model_info, dict):
+            continue
+
+        entity = _create_entity_from_model(app_name, model_name, model_info, include_fields=True)
+        app_entities.append(entity)
+
+        model_relationships = _process_model_relationships(
+            entity["id"], model_name, model_info, all_models_data
+        )
+
+        for relationship in model_relationships:
+            target_entity_id = relationship["target"]
+            target_model = relationship["target_model"]
+            target_app = target_entity_id.split("__")[0]
+
+            if target_app != app_name and target_entity_id not in related_entity_ids:
+                if target_app in all_models_data and target_model in all_models_data[target_app]:
+                    target_model_info = all_models_data[target_app][target_model]
+                    related_entity = _create_entity_from_model(
+                        target_app, target_model, target_model_info, include_fields=False
+                    )
+                    related_entities.append(related_entity)
+                    related_entity_ids.add(target_entity_id)
+
+            relationships.append(relationship)
+
+    content = render_to_string(
+        "er_diagrams/app.html",
+        {
+            "app_name": app_name,
+            "app_entities": app_entities,
+            "related_entities": related_entities,
+            "relationships": relationships,
+        },
+    )
+
+    write_file(f"{drf_to_mkdoc_settings.ER_DIAGRAMS_DIR}/{app_name}.md", content)
+
+
+def generate_er_diagrams_index(models_data: dict[str, Any], _docs_dir: Path) -> None:
+    """Create index page listing all available ER diagrams with app summaries."""
+    apps = []
+
+    for app_name in sorted(models_data.keys()):
+        if not isinstance(models_data[app_name], dict):
+            continue
+
+        model_count = len([
+            m for m in models_data[app_name]
+            if isinstance(models_data[app_name][m], dict)
+        ])
+
+        model_names = []
+        for model_name, model_info in models_data[app_name].items():
+            if isinstance(model_info, dict):
+                model_names.append(model_name)
+                if len(model_names) >= 3:
+                    break
+
+        apps.append({"name": app_name, "model_count": model_count})
+
+    content = render_to_string("er_diagrams/index.html", {"apps": apps})
+    write_file(f"{drf_to_mkdoc_settings.ER_DIAGRAMS_DIR}/index.md", content)

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/drf_to_mkdoc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.2.4
+Version: 0.3.0
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>
@@ -55,6 +55,7 @@ Generate beautiful, interactive Markdown API documentation from Django REST Fram
 
 - **Zero-hassle docs**: Beautiful, always-in-sync API docs straight from your codebase
 - **Model deep dive**: Auto-generated model pages with fields, relationships, and choices
+- **ER Diagrams**: Entity-Relationship diagrams showing model relationships
 - **Lightning-fast discovery**: Interactive endpoint index with powerful filters and search
 - **Try-it-out**: Interactive API testing directly in the documentation with request/response examples
 - **AI-powered**: Optional AI-generated documentation with custom field generators(Wait for it...)
@@ -96,8 +97,9 @@ DRF_TO_MKDOC = {
         'inventory',
     ],
     # Optional: Override default paths
-    # 'DOCS_DIR': 'docs',
+    # 'DOCS_DIR': 'docs',  # Base directory for all generated docs
     # 'CONFIG_DIR': 'docs/configs',
+    # 'ER_DIAGRAMS_DIR': 'er_diagrams',  # Directory for ER diagrams (relative to DOCS_DIR)
     # 'MODEL_DOCS_FILE': 'docs/model-docs.json',
     # 'DOC_CONFIG_FILE': 'docs/configs/doc_config.json',
     # 'CUSTOM_SCHEMA_FILE': 'docs/configs/custom_schema.json',
@@ -112,6 +114,8 @@ DRF_TO_MKDOC = {
 
 2. **Create MkDocs configuration**:  
    Copy the [`docs/mkdocs.yml`](docs/mkdocs.yml) file to your project root and customize it as needed.
+   
+   **Note**: If you change the `ER_DIAGRAMS_DIR` setting, update the navigation path in `mkdocs.yml` accordingly.
 
 3. **Build documentation**:
 
@@ -124,8 +128,9 @@ python manage.py build_docs --settings=docs_settings
 The `DRF_TO_MKDOC` setting supports several configuration options:
 
 - **`DJANGO_APPS`** (required): List of Django app names to process
-- **`DOCS_DIR`**: Directory where docs will be generated (default: `docs`)
+- **`DOCS_DIR`**: Base directory where docs will be generated (default: `docs`)
 - **`CONFIG_DIR`**: Directory for configuration files (default: `docs/configs`)
+- **`ER_DIAGRAMS_DIR`**: Directory for ER diagrams (default: `er_diagrams`, relative to `DOCS_DIR`)
 - **`FIELD_GENERATORS`**: Custom field value generators for better examples
 - **`ENABLE_AI_DOCS`**: Enable AI-powered documentation features (default: `False`)
 - **`PATH_PARAM_SUBSTITUTE_FUNCTION`**: Custom function for path parameter substitution
@@ -153,6 +158,12 @@ See a detailed overview of generated files in `docs/structure.md` and a feature
 - **Floating action button**: Easy access to testing interface
 - **Multiple examples**: Support for both empty and populated response examples
 
+### 📊 Entity-Relationship Diagrams
+- **Visual model relationships**: Interactive ER diagrams showing all model connections
+- **App-specific views**: Detailed diagrams for each Django app with field information
+- **Mermaid-powered**: Clean, professional diagrams with zoom and navigation controls
+- **Auto-generated**: Automatically created from your Django model relationships
+
 ### 🤖 AI-Powered Documentation
 - **Custom field generators**: Define custom value generators for specific fields
 - **AI documentation**: Optional AI-generated documentation with context analysis
@@ -233,6 +244,10 @@ drf-to-mkdoc/
 │       ├── model_list_generator.py
 │       └── schema.py
 ├── docs/                      # Generated documentation
+│   ├── endpoints/             # API endpoint documentation
+│   ├── models/                # Model documentation
+│   ├── er_diagrams/           # Entity-Relationship diagrams
+│   └── configs/               # Configuration files
 ├── pyproject.toml            # Project configuration
 └── README.md
 ```
@@ -251,6 +266,7 @@ To avoid committing generated files to your repository, add the following to you
 # Documentation
 /docs/endpoints/
 /docs/models/
+/docs/er_diagrams/
 /docs/configs/doc-schema.yaml
 
 # Build artifacts
@@ -287,6 +303,10 @@ your-project/
 ├── docs_settings.py     # Documentation-specific settings
 ├── mkdocs.yml          # MkDocs configuration
 ├── docs/               # Generated documentation (gitignored)
+│   ├── endpoints/      # API endpoint docs
+│   ├── models/         # Model documentation
+│   ├── er_diagrams/    # ER diagrams
+│   └── configs/        # Configuration files
 └── site/               # Built site (gitignored)
 ```
 

{drf_to_mkdoc-0.2.4 → drf_to_mkdoc-0.3.0}/drf_to_mkdoc.egg-info/SOURCES.txt

@@ -90,6 +90,9 @@ drf_to_mkdoc/templates/endpoints/list/filters/app.html
 drf_to_mkdoc/templates/endpoints/list/filters/method.html
 drf_to_mkdoc/templates/endpoints/list/filters/path.html
 drf_to_mkdoc/templates/endpoints/list/filters/search.html
+drf_to_mkdoc/templates/er_diagrams/app.html
+drf_to_mkdoc/templates/er_diagrams/index.html
+drf_to_mkdoc/templates/er_diagrams/main.html
 drf_to_mkdoc/templates/model_detail/base.html
 drf_to_mkdoc/templates/model_detail/choices.html
 drf_to_mkdoc/templates/model_detail/fields.html
@@ -105,6 +108,7 @@ drf_to_mkdoc/templatetags/custom_filters.py
 drf_to_mkdoc/utils/__init__.py
 drf_to_mkdoc/utils/endpoint_detail_generator.py
 drf_to_mkdoc/utils/endpoint_list_generator.py
+drf_to_mkdoc/utils/er_diagram_generator.py
 drf_to_mkdoc/utils/model_detail_generator.py
 drf_to_mkdoc/utils/model_list_generator.py
 drf_to_mkdoc/utils/schema.py