django-doc-view 0.1.2

The simplest way to document your Django APIs

# django-doc-view: The simplest way to document your Django APIs

[](https://github.com/ocavue/django-doc-view/blob/master/LICENSE)
[](https://github.com/ambv/black)
[](https://pypi.org/project/django-doc-view)

`django-doc-view` find view's docsting and output them in shell after formatting.

## Installation

```bash
pip3 install django-doc-view
```

## Base Usage

Add `django_doc_view` to your INSTALLED_APPS setting:

```python
# settings.py

INSTALLED_APPS = (
...
'django_doc_view'
)
```

Then you can get the result by doc_view command:

```bash
python3 manage.py doc_view
```

## Example

```python

def index(request):
"""
A example of Function-based view
"""
return HttpResponse("Hello, world. You're at the polls index.")


class User(View):
"""
A example of Class-based view

method:
get
request:
id
"""

def get(self, request, *args, **kwargs):
...
```

```bash

$ python3 manage.py doc_view

## polls/

A example of Function-based view

## polls/user

A example of Class-based view

method:
get
request:
id

```

You can find a runnable example from [here](https://github.com/ocavue/django-doc-view-emample).