{ "info": { "author": "Diederik van der Boor", "author_email": "opensource@edoburu.nl", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Framework :: Django :: 2.0", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": ".. image:: https://img.shields.io/travis/edoburu/sphinxcontrib-django/master.svg?branch=master\n :target: http://travis-ci.org/edoburu/sphinxcontrib-django\n.. image:: https://img.shields.io/pypi/v/sphinxcontrib-django.svg\n :target: https://pypi.python.org/pypi/sphinxcontrib-django/\n.. image:: https://img.shields.io/pypi/l/sphinxcontrib-django.svg\n :target: https://pypi.python.org/pypi/sphinxcontrib-django/\n.. image:: https://img.shields.io/codecov/c/github/edoburu/sphinxcontrib-django/master.svg\n :target: https://codecov.io/github/edoburu/sphinxcontrib-django?branch=master\n\nsphinxcontrib-django\n====================\n\nImprovements for the output of Sphinx's autodoc for Django classes.\n\nThis adds the following improvements:\n\n* Properly show which fields a model has.\n* Properly show which fields a form has.\n* Document the model fields as parameters in the model ``__init__()``.\n* Link foreign key and related fields to the documentation of the referenced class.\n* Hide irrelevant runtime information like ``declared_fieldsets``, ``fieldsets`` and ``Meta`` from classes.\n* A ``:django:setting:`` role to allow linking to Django documentation. (e.g. *:django:setting:`SITE_ID`*)\n\n\nInstallation\n------------\n\nUsage:\n\n.. code-block:: bash\n\n pip install sphinxcontrib-django\n\nAdd to the Sphinx config file (``conf.py``):\n\n.. code-block:: python\n\n extensions = [\n 'sphinx.ext.autodoc',\n 'sphinxcontrib_django',\n ]\n\nAutodoc works by importing your code on the fly, and extracting the data from\nthe Python classes. Thus, the project should be able to import Django models.\nTypically the following needs to be added to ``conf.py``:\n\n.. code-block:: python\n\n sys.path.insert(0, os.path.abspath('../src'))\n os.environ['DJANGO_SETTINGS_MODULE'] = 'myapp.settings'\n django.setup()\n\nTo support the ``:django:setting:`` role, configure Intersphinx:\n\n.. code-block:: python\n\n intersphinx_mapping = {\n 'http://docs.python.org/': None,\n 'https://docs.djangoproject.com/en/stable': 'https://docs.djangoproject.com/en/stable/_objects',\n }\n\n\nRecommendations:\n~~~~~~~~~~~~~~~~\n\nWhen your project uses Celery, include `celery.contrib.sphinx`_ too.\nThis adds an ``autotask::`` directive, and ``:task:`app.tasks.my_task``` role.\n\nOther great extensions are:\n\n* sphinx-autodoc-annotation_: Converts Python 3 annotations to docstrings.\n* ``sphinx.ext.graphviz``: Allows to create diagrams with ease.\n\nAn example configuration may look like:\n\n.. code-block:: python\n\n extensions = [\n 'sphinx.ext.autodoc', # The autodoc core\n 'sphinx.ext.graphviz', # Support creating charts!\n\n 'celery.contrib.sphinx', # Celery improvements!\n 'sphinx_autodoc_annotation', # Parses Python 3 annotations\n 'sphinxcontrib_django', # this module\n ]\n\n\n.. _sphinx-autodoc-annotation: https://github.com/nicolashainaux/sphinx-autodoc-annotation\n.. _celery.contrib.sphinx: http://docs.celeryproject.org/en/latest/reference/celery.contrib.sphinx.html\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/edoburu/sphinxcontrib-django/zipball/master", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/edoburu/sphinxcontrib-django", "keywords": "", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-django", "package_url": "https://pypi.org/project/sphinxcontrib-django/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-django/", "project_urls": { "Download": "https://github.com/edoburu/sphinxcontrib-django/zipball/master", "Homepage": "https://github.com/edoburu/sphinxcontrib-django" }, "release_url": "https://pypi.org/project/sphinxcontrib-django/0.5/", "requires_dist": null, "requires_python": "", "summary": "Improve the Sphinx autodoc for Django classes.", "version": "0.5" }, "last_serial": 5656079, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "44076ff73f1ba9feafaf019bd3d7b68c", "sha256": "68cd6fb6ca5279381dae147278d0f463d75da1bc6df390bdffb1b4128c68db7d" }, "downloads": -1, "filename": "sphinxcontrib_django-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "44076ff73f1ba9feafaf019bd3d7b68c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9439, "upload_time": "2017-12-07T11:28:33", "url": "https://files.pythonhosted.org/packages/04/d8/cbdc93e1de3128beffc09ee6075ede2620d15904e5df861438bc56e55d55/sphinxcontrib_django-0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a3fdc9e7f88d91720e37a069364f3132", "sha256": "3fb547bd7f2103e40324448893857e9c529067993e4b7655beda768008140496" }, "downloads": -1, "filename": "sphinxcontrib-django-0.1.tar.gz", "has_sig": false, "md5_digest": "a3fdc9e7f88d91720e37a069364f3132", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10323, "upload_time": "2017-12-07T11:28:34", "url": "https://files.pythonhosted.org/packages/2e/49/02bd193a6d82a76c7b48c2516ca79f7e2b0652366cb4a7ddcd1e02e3ee0f/sphinxcontrib-django-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "1d67525d8243882175ae20b577c572a7", "sha256": "8575c881adbe56554b89e2f6c624ba98eb580dc262f50764484364ec33b734b4" }, "downloads": -1, "filename": "sphinxcontrib_django-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1d67525d8243882175ae20b577c572a7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9535, "upload_time": "2018-01-02T10:32:02", "url": "https://files.pythonhosted.org/packages/51/64/1bdb42acdadf72e3e67bef5d891355db3c55722f225c935dbec7941a0199/sphinxcontrib_django-0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b1c9472f1bc3dc11a34197f97bbd99ba", "sha256": "aa3d6a2ff741cc2406c806a44d9288b974f6d47e9514be9f7b35d86f11759883" }, "downloads": -1, "filename": "sphinxcontrib-django-0.2.tar.gz", "has_sig": false, "md5_digest": "b1c9472f1bc3dc11a34197f97bbd99ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10423, "upload_time": "2018-01-02T10:32:04", "url": "https://files.pythonhosted.org/packages/2e/dc/83504ccf1c2bc2495249d8dde0c2e86faa85eb8eb2a2d72f8db83f974fc9/sphinxcontrib-django-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "53a231c4914b6bd48222084dc12657f9", "sha256": "15ebcb61bcfbe5f432da4aa9cc7b8249638cde333458ba9ef252867090991a8d" }, "downloads": -1, "filename": "sphinxcontrib_django-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "53a231c4914b6bd48222084dc12657f9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9605, "upload_time": "2018-01-02T10:34:56", "url": "https://files.pythonhosted.org/packages/12/8c/92a2d5ffbe9f26e3f866f300a7aaab4e25d36054d2cb0abee9313f2a4e73/sphinxcontrib_django-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "91a277cc930a406d2116fae23ac5c32e", "sha256": "88e00e36c171cdef486a666e25582887eb6c8c4f4b1fade6d5e8ec17fd32a189" }, "downloads": -1, "filename": "sphinxcontrib-django-0.2.1.tar.gz", "has_sig": false, "md5_digest": "91a277cc930a406d2116fae23ac5c32e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10434, "upload_time": "2018-01-02T10:34:58", "url": "https://files.pythonhosted.org/packages/ea/f2/422b557fa4ef3207705431043dfdf4f232f0dab9e6fddb7ce281c11dab28/sphinxcontrib-django-0.2.1.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "ce5c081ad1de34843705de9eafcbf670", "sha256": "53fe239bef8dbbd0ec6bc623c082387abb3966d77dae0a38fb78366ed5595a94" }, "downloads": -1, "filename": "sphinxcontrib_django-0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ce5c081ad1de34843705de9eafcbf670", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11713, "upload_time": "2018-02-19T10:45:42", "url": "https://files.pythonhosted.org/packages/74/c0/37ed17717fa8213de78657b33ac2fa985131db763e83afad2e47d55306c6/sphinxcontrib_django-0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d2db31ff0e95cd23b985b738305ce77f", "sha256": "8d1b4c53feaf2e71ec0623cc66e3ef9f32324b78574b0336e9323704bdd037ed" }, "downloads": -1, "filename": "sphinxcontrib-django-0.3.tar.gz", "has_sig": false, "md5_digest": "d2db31ff0e95cd23b985b738305ce77f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11662, "upload_time": "2018-02-19T10:45:43", "url": "https://files.pythonhosted.org/packages/8a/31/1b860408ea70321c8269104a175c784504278df35e1aa6d42cd2fd13cbcc/sphinxcontrib-django-0.3.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "231d6a29b86a2ae3afcfda3726e6b456", "sha256": "7cba81be5903cc0a006d8d3a9fb18a449e7d179c6314d0549214bb5a3c598e51" }, "downloads": -1, "filename": "sphinxcontrib_django-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "231d6a29b86a2ae3afcfda3726e6b456", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11761, "upload_time": "2018-03-11T13:06:10", "url": "https://files.pythonhosted.org/packages/4d/72/f80dc1467eea59cba1bb4df336b189c6540525969978cfb51921c23ba987/sphinxcontrib_django-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6866a3ccc8a8009a59eb3f7632a345a8", "sha256": "56425b6c76b4635588595c67fa39657796881b1e5445ebd8167de19f80b399a7" }, "downloads": -1, "filename": "sphinxcontrib-django-0.3.1.tar.gz", "has_sig": false, "md5_digest": "6866a3ccc8a8009a59eb3f7632a345a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11687, "upload_time": "2018-03-11T13:06:11", "url": "https://files.pythonhosted.org/packages/08/68/af92896969b9c64fc9c9777263346b546e95c4bc456c2200ef28e3a8ffd2/sphinxcontrib-django-0.3.1.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "bb90302b4fb7775c60d808baf0ade5ad", "sha256": "bd7f45582ace275e3653fbf84d38caf1d7dbef48213897865933995e3fec1294" }, "downloads": -1, "filename": "sphinxcontrib_django-0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bb90302b4fb7775c60d808baf0ade5ad", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9540, "upload_time": "2018-07-26T12:24:12", "url": "https://files.pythonhosted.org/packages/9f/48/9bc94c44e34b293307906b3b10f77a08cb1aec8257f325f340144549e946/sphinxcontrib_django-0.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ee2740f9c0489e585526acb7e512b9e7", "sha256": "3f3f1bd665a2a6a3b39b870a986f258d381d10cafff6cbc90162a7ea2e3f7871" }, "downloads": -1, "filename": "sphinxcontrib-django-0.4.tar.gz", "has_sig": false, "md5_digest": "ee2740f9c0489e585526acb7e512b9e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11725, "upload_time": "2018-07-26T12:24:13", "url": "https://files.pythonhosted.org/packages/3e/12/8fb0cf4c38015e355f07e7f55e54d52bbb4f0edb0bdd8f2f533d2c1a8176/sphinxcontrib-django-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "c70f6d8f3f9eae431c91269268cef3b5", "sha256": "f5bb52d20b64b51087b44247789adaebfc51fa2fad71bfed42c4ca6c05723838" }, "downloads": -1, "filename": "sphinxcontrib_django-0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c70f6d8f3f9eae431c91269268cef3b5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14239, "upload_time": "2019-08-09T14:18:53", "url": "https://files.pythonhosted.org/packages/2a/4a/18ed8a53508fb24982afa9fd2fbcf7b60724497eea79407925afcd820e18/sphinxcontrib_django-0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e7eb6a10c2be81863da48f1a91a592f6", "sha256": "95831d5d58f780010b0255f298ea03d6bbf971c0f94f631268abd4320400b7db" }, "downloads": -1, "filename": "sphinxcontrib-django-0.5.tar.gz", "has_sig": false, "md5_digest": "e7eb6a10c2be81863da48f1a91a592f6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13169, "upload_time": "2019-08-09T14:18:55", "url": "https://files.pythonhosted.org/packages/4b/5c/2efa5ee6fb1d5ee968fec9b07a1be69af2b70a684c909ad25b18ff1a334b/sphinxcontrib-django-0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c70f6d8f3f9eae431c91269268cef3b5", "sha256": "f5bb52d20b64b51087b44247789adaebfc51fa2fad71bfed42c4ca6c05723838" }, "downloads": -1, "filename": "sphinxcontrib_django-0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c70f6d8f3f9eae431c91269268cef3b5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14239, "upload_time": "2019-08-09T14:18:53", "url": "https://files.pythonhosted.org/packages/2a/4a/18ed8a53508fb24982afa9fd2fbcf7b60724497eea79407925afcd820e18/sphinxcontrib_django-0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e7eb6a10c2be81863da48f1a91a592f6", "sha256": "95831d5d58f780010b0255f298ea03d6bbf971c0f94f631268abd4320400b7db" }, "downloads": -1, "filename": "sphinxcontrib-django-0.5.tar.gz", "has_sig": false, "md5_digest": "e7eb6a10c2be81863da48f1a91a592f6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13169, "upload_time": "2019-08-09T14:18:55", "url": "https://files.pythonhosted.org/packages/4b/5c/2efa5ee6fb1d5ee968fec9b07a1be69af2b70a684c909ad25b18ff1a334b/sphinxcontrib-django-0.5.tar.gz" } ] }