{
    "info": {
        "author": "alfred82santa",
        "author_email": "alfred82santa@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "|doc-master| |pypi-lastrelease| |python-versions|\n|project-status| |project-license| |project-format|\n|project-implementation|\n\n.. |doc-master| image:: https://readthedocs.org/projects/dirty-models-sphinx-extension/badge/?version=latest\n    :target: http://dirty-models-sphinx-extension.readthedocs.io/?badge=latest\n    :alt: Documentation Status\n\n.. |pypi-lastrelease| image:: https://img.shields.io/pypi/v/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: Latest Version\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: Supported Python versions\n\n.. |project-status| image:: https://img.shields.io/pypi/status/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: Development Status\n\n.. |project-license| image:: https://img.shields.io/pypi/l/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: License\n\n.. |project-format| image:: https://img.shields.io/pypi/format/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: Download format\n\n.. |project-implementation| image:: https://img.shields.io/pypi/implementation/dirty-models-sphinx.svg\n    :target: https://pypi.python.org/pypi/dirty-models-sphinx/\n    :alt: Supported Python implementations\n\n.. _Dirty Models: http://dirty-models.readthedocs.io/\n\n.. _Dirty Validators: https://github.com/alfred82santa/dirty-validators\n\n.. _Dirty Models Sphinx extension: http://dirty-models-sphinx-extension.readthedocs.io\n\n.. _Sphinx: http://www.sphinx-doc.org\n\n.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html?highlight=autodoc#module-sphinx.ext.autodoc\n\n\n=============================\nDirty Models Sphinx extension\n=============================\n\n`Sphinx`_ extension for dirty models\n\n-----\nAbout\n-----\n\n`Sphinx`_ extension to help developers to write documentation of\napplications which use `Dirty Models`_.\n\n\nFeatures\n========\n\n* Describe each field with real type.\n\n* All field types defined on `Dirty Models`_ are documented.\n\n* Use prefixed (doc comment using ``#:`` before field) or\n  suffixed (Multiline doc string after field) documentation for each field.\n\n* Document ``read only`` fields.\n\n* Document default value for each field.\n\n* Document datetime format on those fields.\n\n* Able to set a prefix text in model signature.\n\n* Able to set a prefix text in fields signature.\n\n* Able to document field type as annotation or as field directive.\n\n* Able to add models to ``toctree``.\n\n* Able to add model attributes to ``toctree``.\n\n\nChangelog\n=========\n\nVersion 0.4.1\n-------------\n\n* Fix installation.\n\nVersion 0.4.0\n-------------\n\n* Document default timezone on TimeField and DatetimeField.\n* Document forced timezone on DatetimeField.\n* Minor fixes.\n* Fix nested classes.\n* Document EnumField.\n\n\nVersion 0.3.0\n-------------\n\n* Added option to add models to ``toctree``.\n* Added option to add model attributes to ``toctree``.\n* Added option to set prefix model signature.\n* Added option to set prefix model field signature.\n* Added option to use field type as annotation.\n* Added fields to index.\n* Changed default value label to ``Default value``.\n\nIssues\n======\n\n* Latex manual document class builder fails when model attributes are in ``toctree``.\n  That is because it creates a fake sections with same ``ids`` and remove after ``toctree`` is created.\n  So, latex builder does not found references when it try to create links.\n\n------------\nInstallation\n------------\n\nJust use ``pip`` to install it:\n\n.. code-block:: bash\n\n    $ pip install dirty-models-sphinx\n\nAnd add to `Sphinx`_ extensions to your project.\n\n.. warning::\n\n    `autodoc`_ extension (included in Sphinx) is required.\n\n**conf.py file:**\n\n.. code-block:: python\n\n    extensions = [\n        'sphinx.ext.autodoc',\n        'dirty_models_sphinx'\n    ]\n\n\n-------------\nConfiguration\n-------------\n\nIt is possible to modify `Dirty Models Sphinx extension`_ behavior using configuration in ``conf.py`` file.\n\n**dirty_model_add_classes_to_toc**\n\n    If it is ``True`` Dirty Models classes will be added to table of content. Default: ``True``.\n\n**dirty_model_add_attributes_to_toc**\n\n    If it is ``True`` Dirty Models class attributes will be added to table of content, only if classes were added.\n    Default: ``True``.\n\n**dirty_model_class_label**\n\n    It defines a prefix text for Dirty Model class signatures. It is possible to use ``None`` in order to avoid prefix.\n    Default: ``'Model'``.\n\n**dirty_model_property_label**\n\n    It defines a prefix text for Dirty Model class field signatures. It is possible to use ``None`` in\n    order to avoid prefix. Default: ``'property'``.\n\n**dirty_model_field_type_as_annotation**\n\n    If it is ``True`` field type will be shown as annotation to attribute. Otherwise, if it is ``False``, field type\n    will be shown as field directive. Default: ``True``.\n\n-----\nUsage\n-----\n\nJust use regular autodocumenter:\n\n.. code-block:: rst\n\n    .. automodule:: models\n        :members:\n        :show-inheritance:\n\n\n------\nFuture\n------\n\n* Document `Dirty Validators`_.\n\n* Document basic validations.\n\n-------------\nDocumentation\n-------------\n\nhttp://dirty-models-sphinx-extension.readthedocs.io",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/alfred82santa/dirty-models-sphinx",
        "keywords": "",
        "license": "GPLv2",
        "maintainer": "",
        "maintainer_email": "",
        "name": "dirty-models-sphinx",
        "package_url": "https://pypi.org/project/dirty-models-sphinx/",
        "platform": "",
        "project_url": "https://pypi.org/project/dirty-models-sphinx/",
        "project_urls": {
            "Homepage": "https://github.com/alfred82santa/dirty-models-sphinx"
        },
        "release_url": "https://pypi.org/project/dirty-models-sphinx/0.4.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Sphinx extension for dirty models",
        "version": "0.4.2"
    },
    "last_serial": 2880403,
    "releases": {
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a39771985c4b6a489fb803961b929d91",
                    "sha256": "37afe966a29968a43bfa466b9d42bf93648a4f698f3bd79a34c9a47c181c5a4d"
                },
                "downloads": -1,
                "filename": "dirty-models-sphinx-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a39771985c4b6a489fb803961b929d91",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4862,
                "upload_time": "2016-09-15T21:18:05",
                "url": "https://files.pythonhosted.org/packages/98/81/ff8753f16269c1ede8ebd712c6ce30138b90f3bac103d0035fd30cff49c3/dirty-models-sphinx-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f190f9957d50b770055ae0e2dda7a97",
                    "sha256": "65b1aef9202e9969ff3aaec85ea3e7ac12831638543000c7f1082d1a7491f340"
                },
                "downloads": -1,
                "filename": "dirty-models-sphinx-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8f190f9957d50b770055ae0e2dda7a97",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6547,
                "upload_time": "2016-09-20T20:06:20",
                "url": "https://files.pythonhosted.org/packages/a2/18/b8e06c73e1182e6c1adc02749dea263cb485059aafd82dbcd59ea30d9e87/dirty-models-sphinx-0.3.0.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ccb52aca30b54d1bcdb22b13a784cfd2",
                    "sha256": "12c53b90a42fa4e7efd36d70dc8fa7ec2ded56e52a662cb0d81fd415ad30ffff"
                },
                "downloads": -1,
                "filename": "dirty-models-sphinx-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ccb52aca30b54d1bcdb22b13a784cfd2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6832,
                "upload_time": "2016-11-07T20:12:16",
                "url": "https://files.pythonhosted.org/packages/87/78/7c06260036f9166dd145f73a9097d339582f88f554a192ae4b190676d497/dirty-models-sphinx-0.4.0.tar.gz"
            }
        ],
        "0.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c8a059064284bc2b248822542f7dfc56",
                    "sha256": "03c5c2587c66e64148c775c829fa9dc4f8428db96fc1c33a068dff9ce16bf77f"
                },
                "downloads": -1,
                "filename": "dirty-models-sphinx-0.4.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c8a059064284bc2b248822542f7dfc56",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7616,
                "upload_time": "2016-11-07T21:00:24",
                "url": "https://files.pythonhosted.org/packages/39/46/dd752788f02c669aacf9e2e0c0eb97d064b8131ee033748f81b5dbab9e3b/dirty-models-sphinx-0.4.1.tar.gz"
            }
        ],
        "0.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fb67cd762fd265eb44ee4ba89a419bb3",
                    "sha256": "66c4af82f1a31127e750e4231cb1cc6e7ec5eb1b2a1038cdc2add512b071db49"
                },
                "downloads": -1,
                "filename": "dirty-models-sphinx-0.4.2.tar.gz",
                "has_sig": false,
                "md5_digest": "fb67cd762fd265eb44ee4ba89a419bb3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7622,
                "upload_time": "2017-05-17T12:30:49",
                "url": "https://files.pythonhosted.org/packages/9b/a1/d850ed5c74a96676659c4bf6957ef0949a190fafe93f749ddf5de449bd2d/dirty-models-sphinx-0.4.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fb67cd762fd265eb44ee4ba89a419bb3",
                "sha256": "66c4af82f1a31127e750e4231cb1cc6e7ec5eb1b2a1038cdc2add512b071db49"
            },
            "downloads": -1,
            "filename": "dirty-models-sphinx-0.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "fb67cd762fd265eb44ee4ba89a419bb3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7622,
            "upload_time": "2017-05-17T12:30:49",
            "url": "https://files.pythonhosted.org/packages/9b/a1/d850ed5c74a96676659c4bf6957ef0949a190fafe93f749ddf5de449bd2d/dirty-models-sphinx-0.4.2.tar.gz"
        }
    ]
}