tell-k/django-modelsdoc

Create models definitions document from your django project.

django-modelsdoc's Issues

Remove test code from installed packages.

When outputting to stdout, line feed is ignored. (Python3.4)

Add ManyToManyField on "listing_models" result.

Add New option "MODELSDOC_INCLUDE_AUTO_CREATED"

To be able to include auto created Models.

Struggling to use a custom FieldWrapper

Hello !
Thanks for your package, it's great to have a quick readable documentation of one's models.

In my case, some fields have quite a number of choices, so I wanted to write a custom FieldWrapper that would join these choices with a <br> instead of just a space. In order to make it more readable.

I tried the following, but get an error:

// settings.py

MODELSDOC_FIELD_WRAPPER = 'app.custom_field_wrapper'


// custom_field_wrapper.py

from modelsdoc.wrappers import FieldWrapper
from modelsdoc.utils import get_foreignkey, get_choices


class CustomFieldWrapper(FieldWrapper):
    def __init__(self, field, model, connection, attrdocs):
        super().__init__(field, model, connection, attrdocs)

    @property
    def comment(self):
        comment = get_foreignkey(self._field)
        comment += get_choices(self._field)
        key = (self._model._model.__name__, self._field.name)
        comment += '<br>'.join(self._attrdocs.get(key, []))
        return comment

I'm honestly not very familiar with class inheritance, so it's probably errors on my side.
Any chance you could help me out ? Thanks a lot !

The stacktrace error:

File "/Users/Raphael/anaconda/envs/python37/lib/python3.7/site-packages/django/template/base.py", line 836, in _resolve_lookup
    current = getattr(current, bit)
  File "/Users/Raphael/anaconda/envs/python37/lib/python3.7/site-packages/modelsdoc/wrappers.py", line 112, in fields
    for f in get_fields_attr(self._model._meta, django.VERSION)
  File "/Users/Raphael/anaconda/envs/python37/lib/python3.7/site-packages/modelsdoc/wrappers.py", line 112, in <listcomp>
    for f in get_fields_attr(self._model._meta, django.VERSION)
TypeError: 'module' object is not callable