About

Sphinx extension to help developers to write documentation of applications which use Dirty Models.

Installation

Just use pip to install it:

$ pip install dirty-models-sphinx

And add to Sphinx extensions to your project.

conf.py file:

extensions = [
    'sphinx.ext.autodoc',
    'dirty_models_sphinx'
]

Configuration

It is possible to modify Dirty Models Sphinx extension behavior using configuration in conf.py file.

dirty_model_add_classes_to_toc

If it is True Dirty Models classes will be added to table of content. Default: True.

dirty_model_add_attributes_to_toc

If it is True Dirty Models class attributes will be added to table of content, only if classes were added. Default: True.

dirty_model_class_label

It defines a prefix text for Dirty Model class signatures. It is possible to use None in order to avoid prefix. Default: 'Model'.

dirty_model_property_label

It defines a prefix text for Dirty Model class field signatures. It is possible to use None in order to avoid prefix. Default: 'property'.

dirty_model_field_type_as_annotation

If it is True field type will be shown as annotation to attribute. Otherwise, if it is False, field type will be shown as field directive. Default: True.

Usage

Just use regular autodocumenter:

.. automodule:: models
    :members:
    :show-inheritance:

Future

• Document Dirty Validators.

• Document basic validations.

Documentation

http://dirty-models-sphinx-extension.readthedocs.io