django-modelsdoc 0.1.11

–app(-a)

您可以传递指定应用程序名称。仅列出指定的应用程序。

$ python manage.py listing_models --app polls

–output(-o)

它将结果写入指定的文件。

$ python manage.py listing_models --output sample.rst

–format(-f)

您可以选择输出格式。 rst（reStructuredText）或 md（Markdown）。默认格式是 rst。

$ python manage.py listing_models --format md

MODELSDOC_APPS

您可以选择应用程序并更改顺序。

# output only models of poll
MODELSDOC_APPS = (polls,)

MODELSDOC_DISPLAY_FIELDS

您可以选择字段值并更改顺序。

MODELSDOC_DISPLAY_FIELDS = (
    ('Fullname', 'verbose_name'),
    ('Name', 'name'),
    ('Type', 'db_type'),
    ('PK', 'primary_key'),
    ('Unique', 'unique'),
    ('Index', 'db_index'),
    ('Null/Blank', 'null_blank'),
    ('Comment', 'comment'),
)

MODELSDOC_MODEL_OPTIONS

# TODO 更详细的文档

MODELSDOC_MODEL_OPTIONS = (
    'unique_together',
    'index_together',
    'ordering',
    'permissions',
    'get_latest_by',
    'order_with_respect_to',
    'db_tablespace',
    'abstract',
    'swappable',
    'select_on_save',
    'default_permissions',
    'default_related_name'
)

其他设置

# TODO 更详细的文档

MODELSDOC_OUTPUT_TEMPLATE = 'modelsdoc/models'
MODELSDOC_OUTPUT_FORMAT = 'rst' # default format
MODELSDOC_MODEL_WRAPPER = 'modelsdoc.wrappers.ModelWrapper'
MODELSDOC_FIELD_WRAPPER = 'modelsdoc.wrappers.FieldWrapper'
MODELSDOC_INCLUDE_AUTO_CREATED = True

0.1.11（2019年11月28日）

• 添加 models.yaml 模板文件。

0.1.10（2019年11月28日）

• 添加对 YAML 格式的支持。

0.1.9（2018年2月8日）

• 修复 动态设置部分长度。感谢 wanshot。

0.1.8（2017年12月3日）

• 添加对 Django2.0 的支持。

0.1.7（2017年5月29日）

• 添加对 Django1.11 和 Python 3.6 的支持。

0.1.6（2016年11月4日）

• 添加对 Django1.10 的支持。

0.1.5（2016年5月4日）

• 添加对 Python3.5 和 Django1.9 的支持。

0.1.4（2015年9月23日）

• 修复错误。打印模型时忽略换行符。

• 在“listing_models”结果中添加 ManyToManyField 的信息。

0.1.3（2015年7月19日）

• 修复错误。安装测试代码。

• 添加新选项“MODELSDOC_INCLUDE_AUTO_CREATED”

0.1.2（2015年6月21日）

• 错误修复。不包括输出模板。

0.1.0（2015年6月21日）

• 首次发布