dirty-models-sphinx

Dirty Models Sphinx extension

Sphinx extension for dirty models

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

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.

Just use pip to install it:

$ pip install dirty-models-sphinx

And add to Sphinx extensions on your project.

conf.py file:

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

Just use regular autodocumenter:

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

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for dirty-models-sphinx 0.2.0
File	Size	Uploaded
dirty-models-sphinx-0.2.0.tar.gz	4.9 kB	Sep 15, 2016	Details

Download URL	dirty-models-sphinx-0.2.0.tar.gz
Size	4.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`37afe966a29968a43bfa466b9d42bf93648a4f698f3bd79a34c9a47c181c5a4d`
BLAKE2b-256 checksum How to use checksums	`9881ff8753f16269c1ede8ebd712c6ce30138b90f3bac103d0035fd30cff49c3`
Upload date	Sep 15, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No