drf-to-mkdoc 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

drf_to_mkdoc/conf/defaults.py

@@ -14,6 +14,5 @@ DEFAULTS = {
     "AI_CONFIG_DIR_NAME": "ai_code",  # Directory name for AI-generated code files
     "AI_OPERATION_MAP_FILE": "docs/configs/operation_map.json",  # Path to operation map file
     "SERIALIZERS_INHERITANCE_DEPTH": 1,  # Maximum depth for class inheritance analysis
-    # Django apps - required, no default
-    "DJANGO_APPS": None,  # List of Django app names to process
+    "DJANGO_APPS": [],  # If it is empty list, there is no any exclusion
 }

drf_to_mkdoc/conf/settings.py

@@ -7,13 +7,14 @@ from drf_to_mkdoc.conf.defaults import DEFAULTS
 
 
 class DRFToMkDocSettings:
-    required_settings: ClassVar[list[str]] = ["DJANGO_APPS"]
+    required_settings: ClassVar[list[str]] = []
     project_settings: ClassVar[dict[str, Any]] = {"PROJECT_NAME": "drf-to-mkdoc"}
 
     settings_types: ClassVar[dict[str, type]] = {
         "ENABLE_AI_DOCS": bool,
         "AI_CONFIG_DIR_NAME": str,
         "SERIALIZERS_INHERITANCE_DEPTH": int,
+        "DJANGO_APPS": list,
     }
 
     settings_ranges: ClassVar[dict[str, tuple[int, int]]] = {

drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/request-executor.js

@@ -160,9 +160,25 @@ const RequestExecutor = {
             }
         }
 
-        // Get method
+        // Get method - try multiple sources for reliability
+        let method = 'GET'; // Default fallback
+        
+        // First try: method badge data attribute
         const methodBadge = document.querySelector('.method-badge');
-        const method = methodBadge?.dataset.method || 'GET';
+        if (methodBadge?.dataset.method) {
+            method = methodBadge.dataset.method;
+        } else {
+            // Second try: try-out form data attribute
+            const tryOutForm = document.querySelector('.try-out-form');
+            if (tryOutForm?.dataset.method) {
+                method = tryOutForm.dataset.method.toUpperCase();
+            } else {
+                // Third try: method badge text content
+                if (methodBadge?.textContent) {
+                    method = methodBadge.textContent.trim();
+                }
+            }
+        }
 
         return {
             url: fullUrl,

drf_to_mkdoc/utils/endpoint_detail_generator.py

@@ -742,7 +742,7 @@ def parse_endpoints_from_schema(paths: dict[str, Any]) -> dict[str, list[dict[st
 
     for path, methods in paths.items():
         app_name = extract_app_from_operation_id(next(iter(methods.values()))["operationId"])
-        if app_name not in django_apps:
+        if django_apps and app_name not in django_apps:
             continue
 
         for method, endpoint_data in methods.items():

drf_to_mkdoc/utils/schema.py

@@ -2,7 +2,7 @@ import inspect
 import logging
 from importlib import import_module
 from types import SimpleNamespace
-from typing import Any
+from typing import Any, List
 
 from drf_spectacular.openapi import AutoSchema as SpectacularAutoSchema
 from drf_spectacular.plumbing import ComponentRegistry
@@ -208,6 +208,15 @@ class AutoSchema(SpectacularAutoSchema):
     directly to the operation during schema generation instead of using a postprocessing hook.
     """
 
+    def __init__(self, *args, **kwargs):
+        self.tags = kwargs.pop("tags", [])
+        super().__init__()
+
+    def get_tags(self) -> List[str]:
+        if self.tags:
+            return self.tags
+        return super().get_tags()
+
     def get_operation(
         self,
         path: str,

drf_to_mkdoc-0.3.1.dist-info/METADATA

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: drf-to-mkdoc
+Version: 0.3.1
+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>
+License: MIT
+Project-URL: Homepage, https://github.com/shayestehhs/drf-to-mkdoc
+Project-URL: Repository, https://github.com/shayestehhs/drf-to-mkdoc
+Project-URL: Documentation, https://github.com/shayestehhs/drf-to-mkdoc#readme
+Project-URL: Bug Tracker, https://github.com/shayestehhs/drf-to-mkdoc/issues
+Keywords: django,django-rest-framework,documentation,mkdocs,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.0,>=3.2
+Requires-Dist: djangorestframework<4.0,>=3.12
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: drf-spectacular>=0.26.0
+Requires-Dist: mkdocs>=1.4.0
+Requires-Dist: mkdocs-material>=9.0.0
+Requires-Dist: coreapi>=2.3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# DRF to MkDocs
+
+Unlock effortless API documentation for your Django REST Framework project. Automatically generate beautiful, interactive, and maintainable docs that accelerate developer onboarding and streamline your team's workflow.
+
+---
+
+## Why DRF to MkDocs?
+
+`DRF to MkDocs` bridges the gap between your API's OpenAPI schema and user-friendly, maintainable documentation. It introspects your Django models and DRF views to automatically generate a polished, feature-rich documentation site that stays in sync with your codebase, empowering your team to build better APIs, faster.
+
+-   **Effortless Documentation**: Automate the entire process of generating and updating your API docs. Say goodbye to manual work and outdated information.
+-   **Accelerate Onboarding**: Provide new joiners with interactive, easy-to-navigate documentation. The "Try-it-out" feature and clear model relationships help them become productive from day one.
+-   **Deeply Integrated with DRF**: Leverages `drf-spectacular` for accurate schema generation, ensuring your documentation is a true reflection of your API.
+-   **Enhance Developer Experience**: Features like the interactive API console and in-depth model pages streamline development, testing, and debugging for the entire team.
+-   **Beautiful & Professional**: Built on MkDocs with the Material theme for a clean, modern, and responsive UI that you'll be proud to share.
+
+## Gallery
+
+<details>
+<summary>🚀 Interactive Endpoint List & Filtering</summary>
+<img width="1434" height="943" alt="List-EndPoint" src="https://github.com/user-attachments/assets/f886fc7f-afa0-4faa-b9c2-d6f754ca3597" />
+</details>
+
+<details>
+<summary>🔬 Detailed Endpoint View with "Try-it-out"</summary>
+<img width="958" height="887" alt="Detail-EndPoint" src="https://github.com/user-attachments/assets/9d9e3d4b-cb92-4ece-831e-aef45ceec768" />
+<img width="532" height="804" alt="Try-it-out" src="https://github.com/user-attachments/assets/0f483922-60c4-4f62-8fb4-bc7372e82a03" />
+</details>
+
+<details>
+<summary>📚 Rich Model Documentation</summary>
+<img width="906" height="885" alt="Model-fields" src="https://github.com/user-attachments/assets/a1ca369c-ad40-4b05-83ec-ceb1f80aab23" />
+<img width="848" height="886" alt="Model" src="https://github.com/user-attachments/assets/683d6d26-a8e4-4c05-8b5f-11a61a62cb0c" />
+</details>
+
+<details>
+<summary>📈 Entity-Relationship Diagrams</summary>
+<img width="953" height="606" alt="ER-Diagram" src="https://github.com/user-attachments/assets/3d0b1cb0-7ebf-4d4a-a181-1b7dbc9c6a01" />
+</details>
+
+## Key Features
+
+| Feature                          | Description                                                                                                                              |
+| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| 🚀 **Interactive API Console**     | Test endpoints directly from the documentation with a "Try-it-out" feature, complete with a request builder and response viewer.         |
+| 🔍 **Advanced Filtering & Search** | Instantly find endpoints with multi-criteria filtering by app, method, path, and a real-time search.                                   |
+| 📚 **In-Depth Model Pages**        | Automatically generate detailed pages for each model, including fields, relationships, choices, and methods.                           |
+| 📊 **Entity-Relationship Diagrams** | Visualize model relationships with auto-generated, interactive ER diagrams for each app and for the entire project.                    |
+| 🎨 **Modern & Responsive UI**      | A beautiful and intuitive interface powered by MkDocs Material, featuring light/dark themes and full mobile support.                   |
+| 🔧 **Highly Customizable**         | Override templates, configure settings, and use custom functions to tailor the documentation to your project's specific needs.         |
+| ⚙️ **Simple Integration**         | Works seamlessly with existing DRF projects and `drf-spectacular` without requiring complex setup.                                     |
+| 🤖 **AI-Powered Enhancements**     | (Working on it...) Leverage AI to generate smarter examples and more descriptive documentation for your API.                                     |
+
+## Getting Started
+
+### 1. Installation
+
+```bash
+pip install drf-to-mkdoc
+```
+
+### 2. Configure Your Django Project
+
+In your `settings.py`:
+
+```python
+# settings.py
+
+INSTALLED_APPS = [
+    # ... your other apps
+    'drf_to_mkdoc',
+    'drf_spectacular',  # Required for schema generation
+]
+
+# Required for OpenAPI schema generation
+REST_FRAMEWORK = {
+    'DEFAULT_SCHEMA_CLASS': 'drf_to_mkdoc.utils.schema.AutoSchema',
+}
+
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'Your API',
+    'DESCRIPTION': 'Your API description',
+    'VERSION': '1.0.0',
+}
+
+# DRF to MkDocs specific settings
+DRF_TO_MKDOC = {
+    'DJANGO_APPS': [
+        'users',
+        'products',
+        # ... list all apps you want to document
+    ],
+}
+```
+
+### 3. Create MkDocs Configuration
+
+Create an `mkdocs.yml` file in your project root. You can start with the [default configuration](docs/mkdocs.yml) and customize it.
+
+### 4. Build Your Documentation
+
+```bash
+python manage.py build_docs
+```
+
+For more detailed instructions, see the full [Installation and Setup Guide](docs/installation.md).
+
+## Usage and Customization
+
+### Building Your Documentation
+
+To build the entire documentation site, run the following command. This will generate a static site in your `site/` directory.
+
+```bash
+python manage.py build_docs
+```
+
+For more granular control, `DRF to MkDocs` provides several commands, such as `build_endpoint_docs` and `build_model_docs`.
+
+### Serving Docs with Django
+
+You can serve your documentation directly from your Django application, protecting it with Django's authentication system. This is ideal for private or internal APIs.
+
+For a complete guide, see [Serving Docs with Django](docs/serving_docs_with_django.md).
+
+### Customizing the OpenAPI Schema
+
+`DRF to MkDocs` allows you to override and extend the auto-generated OpenAPI schema by providing a custom JSON file. This gives you fine-grained control over the final documentation, enabling you to add examples, descriptions, or even custom endpoints.
+
+For more details, refer to the [Customizing Endpoints](docs/customizing_endpoints.md) guide.
+
+### Best Practices
+
+For better project organization, we recommend creating a separate `docs_settings.py` for documentation-specific configurations and using the `--settings` flag:
+
+```bash
+python manage.py build_docs --settings=my_project.docs_settings
+```
+
+This keeps your production settings clean and your documentation configuration isolated.
+
+## Configuration
+
+You can customize the behavior of `DRF to MkDocs` by configuring the `DRF_TO_MKDOC` dictionary in your settings file.
+
+| Key                              | Description                                                                    | Default                               |
+| -------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------- |
+| `DJANGO_APPS` (required)         | A list of Django app names to process.                                         | `[]`                                  |
+| `DOCS_DIR`                       | The base directory where documentation will be generated.                      | `'docs'`                              |
+| `ER_DIAGRAMS_DIR`                | The directory for ER diagrams, relative to `DOCS_DIR`.                         | `'er_diagrams'`                       |
+| `FIELD_GENERATORS`               | Custom field value generators for creating better examples.                    | `{}`                                  |
+| `ENABLE_AI_DOCS`                 | A flag to enable AI-powered documentation features.                            | `False`                               |
+| `PATH_PARAM_SUBSTITUTE_FUNCTION` | A custom function for substituting path parameters in URLs.                    | `None`                                |
+| `PATH_PARAM_SUBSTITUTE_MAPPING`  | A mapping for substituting common path parameters (e.g., `{'pk': 1}`).        | `{}`                                  |
+
+## How It Works
+
+`DRF to MkDocs` operates in a few stages:
+
+1.  **Model Introspection**: It deeply analyzes your Django models, mapping out their fields, relationships (like ForeignKeys and ManyToManyFields), and metadata.
+2.  **Schema Generation**: It uses `drf-spectacular` to generate a detailed OpenAPI schema for your API endpoints.
+3.  **Template Rendering**: It renders Jinja2 templates for each endpoint, model, and ER diagram, creating Markdown files.
+4.  **MkDocs Build**: Finally, it invokes MkDocs to build a static HTML site from the generated Markdown files.
+
+This process ensures that your documentation is always an accurate and comprehensive reflection of your codebase.
+
+## Contributing
+
+Contributions are welcome! Whether it's a bug report, a new feature, or an improvement to the documentation, we appreciate your help. To ensure code quality, we use **CoderabbitAI** for automated code reviews on all pull requests.
+
+Please see our [Contributing Guidelines](CONTRIBUTING.md) to get started.
+
+### Development Setup
+
+```bash
+git clone https://github.com/Shayestehhs/drf-to-mkdoc.git
+cd drf-to-mkdoc
+pip install -e ".[dev]"
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

{drf_to_mkdoc-0.3.0.dist-info → drf_to_mkdoc-0.3.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 drf_to_mkdoc/__init__.py,sha256=IbTW5uKQvJRG9ncHRuk_AGKHPn4ruxs5LqDpUFgUhws,180
 drf_to_mkdoc/apps.py,sha256=-NrC_dRr6GmLmNQhkNh819B7V1SS4DYDv5JOR0TtuJM,560
 drf_to_mkdoc/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-drf_to_mkdoc/conf/defaults.py,sha256=69z61GT02PqaBvo4W-wuyI9Xrdgph_qIbGrzx0EG5gg,1104
-drf_to_mkdoc/conf/settings.py,sha256=5oGHe3du6W4zQtfO3D2RWopLm7OqZQ11ftRUqiJcaS4,5483
+drf_to_mkdoc/conf/defaults.py,sha256=5qbjvHvhhkQChRdy3tJvGRoJ1uXzBfoiHf71kt3a3XI,1072
+drf_to_mkdoc/conf/settings.py,sha256=sxg3VIlhUkcxL1g-21E3FSuwqH4MfL9C3m2QwGw5rqA,5499
 drf_to_mkdoc/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/build_docs.py,sha256=k2N8i7sNWPJGVzUSdkDu47FleCSjIxClRq1dWBHwhjQ,4057
@@ -19,7 +19,7 @@ drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/form-manager.js,sha256=6KIe
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/main.js,sha256=W0Vv9jdCturToACs_wapZ37ux0nRXy1d3GqfXq-0NuI,1821
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/modal.js,sha256=IUg33Er2cF6qzIbxgnvlj8C_fSjNariyfFd3zswu3wU,14238
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/query-parameters-extractor.js,sha256=3b6XshRFdf5TeZNktgxEBenEFWTTEsKjYZll0xMUv3Q,3542
-drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/request-executor.js,sha256=CsIusYZ5RIJXQFN3eh3ZcTLgf6hoZJ7E9BP1_EGsSiA,11904
+drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/request-executor.js,sha256=lBKP-GbUyXKhIGS1q0V0GxeJueRHTjfaDorIgB-LClg,12565
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/response-modal.js,sha256=D8Xd9rEAJpMPExVxSmJ7PaQXCmIfRPhyv6t93A0AP0w,5671
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/suggestions.js,sha256=WOXppK1HgYFDbVkCvchBKxL8rc_974roJAxZE2EBdDo,4396
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out/tabs.js,sha256=WwAjbisNap0lOQ3pZyWkW0G7hXvy_gFjHMCCPUu50a8,2791
@@ -87,12 +87,12 @@ drf_to_mkdoc/templates/try-out/modal.html,sha256=G3Ye6DntMVVYUnmbwkrf-YcYmw7AxtC
 drf_to_mkdoc/templates/try-out/response-modal.html,sha256=mjt1bud07Y3BXp7716mQMlrv8xGRaQr4W2XRNKJWwGA,5980
 drf_to_mkdoc/templatetags/custom_filters.py,sha256=b_0ExGgBKUIlNkJ8nXlc6mrhhiUUxtdq9thXH-yzEq4,3761
 drf_to_mkdoc/utils/__init__.py,sha256=6dFTb07S6yIf-INMy0Mlgf5purNir687ZU9WZtITh4k,68
-drf_to_mkdoc/utils/endpoint_detail_generator.py,sha256=qYFM84KuiygNMNGQ_aiT6nxVexWtM8mZb3WfFrV8zVU,28375
+drf_to_mkdoc/utils/endpoint_detail_generator.py,sha256=toZ3JWlVHtsYPJLG8ZDvLYtfsbNr3P-YEINKpOElwQ4,28391
 drf_to_mkdoc/utils/endpoint_list_generator.py,sha256=yVX7qVUTuKF3TPFgm6FI-vVsVZQ7XHMXmZZalgSN8pk,3579
 drf_to_mkdoc/utils/er_diagram_generator.py,sha256=9X4L2XPVSKwxHZQspOSMg7TacAzImeXGgYPzhlsL-U8,7962
 drf_to_mkdoc/utils/model_detail_generator.py,sha256=_ac2PYSzSwRUgUn-J-nmg7mfQGn8SU_4vkMpMRIxgEU,2619
 drf_to_mkdoc/utils/model_list_generator.py,sha256=Ki-CwIYKmUbPm3_jUPLPosPfppyVLrZMkqbuPPO3Ycw,1988
-drf_to_mkdoc/utils/schema.py,sha256=sDhVITdIFp1TJYnqCd4wF69i-lwXGlTsNJ2-ngXkccc,10070
+drf_to_mkdoc/utils/schema.py,sha256=vVLnnVt3ANaHSAdrsjOEfkakZZufeR5PUSuo2dyR4vU,10311
 drf_to_mkdoc/utils/ai_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/utils/ai_tools/enums.py,sha256=K39bJjHgXwNst2NL6z-5bztW3ZU5iCxg2b0KEodD6eM,238
 drf_to_mkdoc/utils/ai_tools/exceptions.py,sha256=yFauOtuSRGRnQt41u2qCMvWEbN0eblgKwXuH-GX3Wbk,634
@@ -109,8 +109,8 @@ drf_to_mkdoc/utils/commons/path_utils.py,sha256=Pi9g1xXDPsRzmn4kTeNSVtXG9v6n1h2Z
 drf_to_mkdoc/utils/commons/schema_utils.py,sha256=1mQxzo08J6tlVmTIJ0hCQ6wCZUWMuV82POhLWUfOYtI,7567
 drf_to_mkdoc/utils/extractors/__init__.py,sha256=BvC8gKOPVI9gU1Piw0jRhKQ2ER5s1moAxgq7ZYkJWNI,86
 drf_to_mkdoc/utils/extractors/query_parameter_extractors.py,sha256=xELPYI6tcqfkxOa475JPMaxRzRGUX--Z9oYRlKgXb7w,7964
-drf_to_mkdoc-0.3.0.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
-drf_to_mkdoc-0.3.0.dist-info/METADATA,sha256=Qdnb11wv-MfHGoC0oGA160pjaNXUzcwL6J_noRbi-8c,11950
-drf_to_mkdoc-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-drf_to_mkdoc-0.3.0.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
-drf_to_mkdoc-0.3.0.dist-info/RECORD,,
+drf_to_mkdoc-0.3.1.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
+drf_to_mkdoc-0.3.1.dist-info/METADATA,sha256=vsGgQCWq3UUXiVIPrNo8DvyKkkFxXiolEVmtZNu2iwI,11692
+drf_to_mkdoc-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+drf_to_mkdoc-0.3.1.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
+drf_to_mkdoc-0.3.1.dist-info/RECORD,,

drf_to_mkdoc-0.3.0.dist-info/METADATA

@@ -1,315 +0,0 @@
-Metadata-Version: 2.4
-Name: drf-to-mkdoc
-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>
-License: MIT
-Project-URL: Homepage, https://github.com/shayestehhs/drf-to-mkdoc
-Project-URL: Repository, https://github.com/shayestehhs/drf-to-mkdoc
-Project-URL: Documentation, https://github.com/shayestehhs/drf-to-mkdoc#readme
-Project-URL: Bug Tracker, https://github.com/shayestehhs/drf-to-mkdoc/issues
-Keywords: django,django-rest-framework,documentation,mkdocs,api
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.0
-Classifier: Framework :: Django :: 4.1
-Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Documentation
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Django<6.0,>=3.2
-Requires-Dist: djangorestframework<4.0,>=3.12
-Requires-Dist: PyYAML>=6.0
-Requires-Dist: drf-spectacular>=0.26.0
-Requires-Dist: mkdocs>=1.4.0
-Requires-Dist: mkdocs-material>=9.0.0
-Requires-Dist: coreapi>=2.3.0
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-django>=4.5.0; extra == "dev"
-Requires-Dist: black>=22.0.0; extra == "dev"
-Requires-Dist: isort>=5.10.0; extra == "dev"
-Requires-Dist: flake8>=5.0.0; extra == "dev"
-Requires-Dist: mypy>=1.0.0; extra == "dev"
-Dynamic: license-file
-
-# DRF to MkDocs
-
-Generate beautiful, interactive Markdown API documentation from Django REST Framework OpenAPI schema for MkDocs.
-
-## Why you'll love it
-
-- **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...)
-- **DRF-native**: Works with DRF Spectacular; no custom schema wiring needed
-- **MkDocs Material**: Looks great out of the box with the Material theme
-
-## Installation
-
-See the full installation guide in `docs/installation.md`.
-
-## Quick Start
-
-1. **Configure your Django project**:
-
-```python
-# settings.py
-INSTALLED_APPS = [
-    # ... your other apps
-    'drf_to_mkdoc',
-]
-
-# Required for OpenAPI schema generation
-REST_FRAMEWORK = {
-    'DEFAULT_SCHEMA_CLASS': 'drf_to_mkdoc.utils.schema.AutoSchema',
-}
-
-SPECTACULAR_SETTINGS = {
-    'TITLE': 'Your API',
-    'DESCRIPTION': 'Your API description',
-    'VERSION': '1.0.0',
-
-}
-
-DRF_TO_MKDOC = {
-    'DJANGO_APPS': [
-        'users',
-        'products',
-        'orders',
-        'inventory',
-    ],
-    # Optional: Override default paths
-    # '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',
-    # 'FIELD_GENERATORS': {
-    #     'email': 'faker.email',
-    #     'name': 'faker.name',
-    #     'created_at': 'datetime.now',
-    # },
-    # 'ENABLE_AI_DOCS': False,
-}
-```
-
-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**:
-
-```bash
-python manage.py build_docs --settings=docs_settings
-```
-
-### Configuration Options
-
-The `DRF_TO_MKDOC` setting supports several configuration options:
-
-- **`DJANGO_APPS`** (required): List of Django app names to process
-- **`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
-- **`PATH_PARAM_SUBSTITUTE_MAPPING`**: Mapping for path parameter substitution
-
-## Available Commands
-
-- `build_docs`: Build the complete documentation site with MkDocs
-- `build_endpoint_docs`: Build endpoint documentation from OpenAPI schema
-- `build_model_docs`: Build model documentation from model JSON data
-- `extract_model_data`: Extract model data from Django model introspection and save as JSON
-- `generate_doc_json`: Generate JSON context for new API endpoints to be documented
-- `update_doc_schema`: Update the final schema by copying the documented schema
-
-## What you get
-
-See a detailed overview of generated files in `docs/structure.md` and a feature breakdown in `docs/features.md`.
-
-## Key Features
-
-### 🚀 Interactive API Testing (Try-Out)
-- **Live API testing**: Test endpoints directly from the documentation
-- **Request builder**: Interactive forms for parameters, headers, and request body
-- **Response viewer**: Real-time response display with syntax highlighting
-- **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
-- **Smart examples**: Enhanced example generation for better API understanding
-
-### 📊 Advanced Filtering & Search
-- **Multi-criteria filtering**: Filter by app, HTTP method, path, and search terms
-- **Real-time search**: Instant search across all endpoints
-- **Smart suggestions**: Auto-complete for query parameters and field names
-
-### 🎨 Beautiful UI
-- **Material Design**: Modern, responsive interface with dark/light themes
-- **Interactive elements**: Hover effects, animations, and smooth transitions
-- **Mobile-friendly**: Fully responsive design for all devices
-
-## How it works
-
-Under the hood, drf-to-mkdoc introspects your models and reads your DRF OpenAPI schema to generate clean, organized Markdown. Then MkDocs turns it into a polished static site. Always current, no manual updates.
-
-## Explore more
-
-- Customizing endpoint docs: `docs/customizing_endpoints.md`
-- Serving docs through Django (with permissions): `docs/serving_mkdocs_with_django.md`
-
-## Dependencies
-
-- Django >= 3.2, < 6.0
-- Django REST Framework >= 3.12, < 4.0
-- drf-spectacular >= 0.26.0
-- PyYAML >= 6.0
-- MkDocs >= 1.4.0
-- MkDocs Material >= 9.0.0
-- coreapi >= 2.3.0
-
-## Development
-
-### Setup Development Environment
-
-```bash
-git clone https://github.com/Shayestehhs/drf-to-mkdoc.git
-cd drf-to-mkdoc
-pip install -e ".[dev]"
-```
-
-## Project Structure
-
-```
-drf-to-mkdoc/
-├── drf_to_mkdoc/
-│   ├── conf/
-│   │   ├── defaults.py      # Default configuration values
-│   │   └── settings.py      # Settings management
-│   ├── management/
-│   │   └── commands/
-│   │       ├── build_docs.py           # Build MkDocs site
-│   │       ├── build_endpoint_docs.py  # Build endpoint documentation
-│   │       ├── build_model_docs.py     # Build model documentation
-│   │       ├── extract_model_data.py   # Extract model data from Django
-│   │       ├── generate_doc_json.py    # Generate JSON context for AI docs
-│   │       └── update_doc_schema.py    # Schema updates
-│   ├── static/
-│   │   └── drf-to-mkdoc/
-│   │       ├── javascripts/
-│   │       │   ├── try-out/            # Interactive API testing
-│   │       │   └── endpoints-filter.js # Endpoint filtering
-│   │       └── stylesheets/            # CSS for styling
-│   ├── templates/
-│   │   ├── endpoints/                  # Endpoint documentation templates
-│   │   ├── model_detail/               # Model documentation templates
-│   │   └── try-out/                    # Interactive testing templates
-│   └── utils/
-│       ├── ai_tools/                   # AI-powered documentation features
-│       ├── commons/                    # Shared utilities
-│       ├── extractors/                 # Query parameter extraction
-│       ├── endpoint_detail_generator.py
-│       ├── endpoint_list_generator.py
-│       ├── model_detail_generator.py
-│       ├── 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
-```
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Recommendations
-
-### .gitignore Configuration
-
-To avoid committing generated files to your repository, add the following to your `.gitignore` file:
-
-```gitignore
-# Documentation
-/docs/endpoints/
-/docs/models/
-/docs/er_diagrams/
-/docs/configs/doc-schema.yaml
-
-# Build artifacts
-/site/
-```
-
-This will ensure that only the source configuration and scripts are versioned, while the generated documentation is excluded.
-
-### docs_settings.py Best Practices
-
-Create a separate `docs_settings.py` file that inherits from your main settings:
-
-```python
-# docs_settings.py
-from .settings import *
-
-DRF_TO_MKDOC = {
-    'DJANGO_APPS': ['your_app1', 'your_app2'],
-}
-# Other doc settings...
-```
-
-Then use the `--settings` argument when running the build command:
-
-```bash
-python manage.py build_docs --settings=docs_settings
-```
-
-### Project Organization
-
-```
-your-project/
-├── settings.py          # Main Django settings
-├── 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)
-```
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.