drf-to-mkdoc 0.3.4__tar.gz

drf_to_mkdoc-0.3.4/.github/workflows/publish.yaml

@@ -0,0 +1,43 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on tags like v1.0.0
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi  # Make sure this environment exists in repo settings
+
+    permissions:
+      contents: read
+      id-token: write  # Required for PyPI trusted publishing
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install build tools and setuptools_scm
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools_scm[toml]
+
+      - name: Verify version detection
+        run: |
+          echo "Detected version: $(python -m setuptools_scm)"
+          echo "Git describe: $(git describe --tags)"
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

drf_to_mkdoc-0.3.4/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.4
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  

drf_to_mkdoc-0.3.4/CONTRIBUTING.md

@@ -0,0 +1,127 @@
+# Contributing to DRF to MkDocs
+
+Thank you for your interest in contributing to DRF to MkDocs! This document provides guidelines and information for contributors.
+
+## Getting Started
+
+1. **Fork the repository**
+   - Go to the main repository page
+   - Click the "Fork" button to create your own copy
+
+2. **Clone your fork**
+   ```bash
+   git clone https://github.com/yourusername/drf-to-mkdoc.git
+   cd drf-to-mkdoc
+   ```
+
+3. **Set up development environment**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+4. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+## Development Guidelines
+
+### Code Style
+
+- Follow PEP 8 style guidelines
+- Use meaningful variable and function names
+- Add docstrings to all public functions and classes
+- Keep functions focused and single-purpose
+
+### Documentation
+
+- Update README.md if adding new features
+- Add docstrings to new functions and classes
+- Update inline comments for complex logic
+- Consider adding examples for new functionality
+
+## Making Changes
+
+1. **Make your changes**
+   - Implement your feature or fix
+   - Follow the coding guidelines above
+   - Test your changes thoroughly
+
+2. **Commit your changes**
+   ```bash
+   git add .
+   git commit -m "Add feature: brief description of changes"
+   ```
+
+3. **Push to your fork**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+4. **Create a pull request**
+   - Go to your fork on GitHub
+   - Click "New Pull Request"
+   - Select your feature branch
+   - Fill out the pull request template
+
+## Pull Request Guidelines
+
+### Before Submitting
+
+- [ ] Code follows style guidelines
+- [ ] Documentation is updated
+- [ ] No breaking changes (or clearly documented)
+- [ ] Feature is tested with multiple Django versions
+
+### Pull Request Template
+
+```markdown
+## Description
+Brief description of the changes made.
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Code refactoring
+
+## Testing
+Describe how you tested your changes.
+
+## Checklist
+- [ ] My code follows the style guidelines
+- [ ] I have performed a self-review
+- [ ] I have commented my code where necessary
+- [ ] I have made corresponding changes to documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective
+```
+
+## Issue Reporting
+
+When reporting issues, please include:
+
+- **Django version**: The version you're using
+- **DRF version**: Django REST Framework version
+- **Python version**: Your Python version
+- **Error message**: Full error traceback
+- **Steps to reproduce**: Clear steps to reproduce the issue
+- **Expected behavior**: What you expected to happen
+- **Actual behavior**: What actually happened
+
+## Code of Conduct
+
+- Be respectful and inclusive
+- Focus on the code and technical discussions
+- Help others learn and improve
+- Report any inappropriate behavior to maintainers
+
+## Questions?
+
+If you have questions about contributing, feel free to:
+
+- Open an issue for general questions
+- Ask in pull request comments
+- Contact maintainers directly
+
+Thank you for contributing to DRF to MkDocs! 

drf_to_mkdoc-0.3.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ShayestehHs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

drf_to_mkdoc-0.3.4/MANIFEST.in

@@ -0,0 +1,19 @@
+include README.md
+include LICENSE
+include MANIFEST.in
+include pyproject.toml
+
+recursive-include drf_to_mkdoc/conf *.py
+recursive-include drf_to_mkdoc/utils *.py
+recursive-include drf_to_mkdoc/management *.py
+recursive-include static *
+
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__
+global-exclude .DS_Store
+global-exclude .git*
+global-exclude .idea
+global-exclude .venv
+global-exclude .env
+global-exclude *.log

drf_to_mkdoc-0.3.4/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: drf-to-mkdoc
+Version: 0.3.4
+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.4/README.md

@@ -0,0 +1,183 @@
+# 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.4/conf/defaults.py

@@ -0,0 +1,11 @@
+DEFAULTS = {
+    "TEMPLATES_DIR": None,  # Optional override directory
+    "PAGINATION_MAP": {
+        "rest_framework.pagination.PageNumberPagination": "pagination/page_number.md",
+        "rest_framework.pagination.LimitOffsetPagination": "pagination/limit_offset.md",
+        "rest_framework.pagination.CursorPagination": "pagination/cursor.md",
+    },
+    "INDEX_TEMPLATE": "index.md",
+    "AUTH_TEMPLATE": "auth.md",
+    "PATH_PARAM_SUBSTITUTOR": None,
+}

drf_to_mkdoc-0.3.4/conf/settings.py

@@ -0,0 +1,21 @@
+from django.conf import settings
+
+from .defaults import DEFAULTS
+
+
+class DocBuilderSettings:
+    def __init__(self, user_settings_key="DOC_BUILDER", defaults=None):
+        self.user_settings_key = user_settings_key
+        self._user_settings = getattr(settings, user_settings_key, {})
+        self.defaults = defaults or {}
+
+    def get(self, key):
+        if key not in self.defaults:
+            raise AttributeError(f"Invalid DOC_BUILDER setting: '{key}'")
+        return self._user_settings.get(key, self.defaults[key])
+
+    def __getattr__(self, key):
+        return self.get(key)
+
+
+drf_to_mkdoc_settings = DocBuilderSettings(defaults=DEFAULTS)