Metadata-Version: 2.2
Name: autodoc-django
Version: 0.1.1
Summary: Provide an automatic documentation for Django's Apps
Home-page: https://github.com/GomesMarcos/autodoc-django
Author: Marcos Gomes
Author-email: gomes.marcosjf@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asgiref>=3.8.1
Requires-Dist: Django>=4.2.19
Requires-Dist: python-decouple>=3.8
Requires-Dist: ruff>=0.7.1
Requires-Dist: sqlparse>=0.5.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Autodoc-Django

An auto documentation tool for Django's Apps with [MermaidJS](https://mermaid.live/) in MarkDown files.
<p style="text-align: center;">

```mermaid
graph TD
    A[Django developer] --> B{Has docs?};
    B -- Yes --> C[Ship it!];
    B -- No --> D[Use django-autodoc];
    D --> E[Generate docs];
    E --> F[Ship it!];

```
</p>

### Installation and Setup
To install Autodoc-Django, run the following command:

```bash
pip install autodoc-django
```
In `settings.py` file, add `autodoc` on `INSTALLED_APPS` constant.
```
INSTALLED_APPS = [
    ...
    "autodoc",
]
```

### Usage
To generate a **Flow Chart** documentation for your Django project, use the following command:

```bash
python3 manage.py autodoc_flow <app_name>
```

To generate a **Sequence Diagram** documentation for your Django project, use the following command:

```bash
python3 manage.py autodoc_sequence <app_name>
```

This will create documentation based on your Django models and views.

### Contributing
Contributions to Autodoc-Django are welcome! Please fork the repository and submit a pull request.

### License
Autodoc-Django is licensed under the MIT License.
