dirty-models-sphinx 0.2.0

Sphinx extension for dirty models

Dirty Models Sphinx extension

Sphinx extension for dirty models

About

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

Features

• Describe each field with real type.

• All field types defined on Dirty Models are documented.

• Use prefixed (doc comment using #: before field) or suffixed (Multiline doc string after field) documentation for each field.

• Document read only fields.

• Document default value for each field.

• Document datetime format on those fields.

Installation

Just use pip to install it:

$ pip install dirty-models-sphinx

And add to Sphinx extensions on your project.

Warning

autodoc extension (included in Sphinx) is required.

conf.py file:

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

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