{ "info": { "author": "Anthony Monthe (ZuluPro)", "author_email": "anthony.monthe@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "Sphinx Django Command\n=====================\n\n.. image:: https://api.travis-ci.org/ZuluPro/sphinx-django-command.svg\n :target: https://travis-ci.org/ZuluPro/sphinx-django-command\n\nAdd you Django Command's help to your documentation. Just write: ::\n\n .. djcommand:: myapp.management.commands.mycmd\n\nAnd you'll have: ::\n\n Usage: manage.py mycmd [options] \n\n Options:\n --version show program's version number and exit\n -h, --help show this help message and exit\n\nUseful to keep DRY documentation between Sphinx and your command help.\n\nSetup\n=====\n\nInstall with: ::\n\n pip install sphinx-django-command\n\nBe sure your Sphinx ``conf.py`` has access to the command that you want to\ndocument, the app could be found in ``sys.path`` and ``DJANGO_SETTINGS_MODULE``\nis available if necessary.\n\nInsert ``'djcommanddoc'`` in the ``extensions`` parameter: ::\n\n extensions = [\n ...\n 'djcommanddoc',\n ...\n ]\n\n\nTests\n=====\n\nTests are stored in `djcommanddoc.tests` and for run them you must launch:\n\n::\n\n python djcommanddoc/tests.py\n\n\nTo run the tests across all supported versions of Django and Python, you\ncan use Tox. Firstly install Tox:\n\n::\n\n pip install tox\n\nTo run the tests just use the command ``tox`` in the command line. If you\nwant to run the tests against just one specific test environment you can run\n``tox -e ``. For example, to run the tests with Python3.3 and\nDjango1.9 you would run:\n\n::\n\n tox -e py3.3\n\nThe available test environments can be found in ``tox.ini``.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ZuluPro/sphinx-django-command", "keywords": "django,sphinx,argparse,optparse", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinx-django-command", "package_url": "https://pypi.org/project/sphinx-django-command/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinx-django-command/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/ZuluPro/sphinx-django-command" }, "release_url": "https://pypi.org/project/sphinx-django-command/0.1.3/", "requires_dist": null, "requires_python": null, "summary": "Sphinx plugin for help Django commands documentation.", "version": "0.1.3" }, "last_serial": 2283093, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "d0749c94643ad7bd3833defb77ae8ecb", "sha256": "2d6f164dc286f7fe8b5bac124f9d762be6d8a709cdb1de57254362091746a40a" }, "downloads": -1, "filename": "sphinx-django-command-0.1.tar.gz", "has_sig": false, "md5_digest": "d0749c94643ad7bd3833defb77ae8ecb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3963, "upload_time": "2016-08-07T14:40:58", "url": "https://files.pythonhosted.org/packages/ae/b1/531f2f75ecf9e7d68217c2e8c69a225de1772baa3a3390913163e50f49ef/sphinx-django-command-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c5a8b3ebf347f185456dccfda8f802a3", "sha256": "719a1faadecd8b7f8b6e595b6020a394a577c1b00912fada8c4b0fe7c1755881" }, "downloads": -1, "filename": "sphinx-django-command-0.1.1.tar.gz", "has_sig": false, "md5_digest": "c5a8b3ebf347f185456dccfda8f802a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4026, "upload_time": "2016-08-09T19:13:39", "url": "https://files.pythonhosted.org/packages/b4/da/485784e6c93783183d6f588869ff886f65ee80c42e1a0ed488cea8707259/sphinx-django-command-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "d109c47e7fac9541e3d7dff5c809ed18", "sha256": "ef74452d58a09f02b0285542a10e4a4680298e0dc894fce1bb58beda66a460a1" }, "downloads": -1, "filename": "sphinx-django-command-0.1.2.tar.gz", "has_sig": false, "md5_digest": "d109c47e7fac9541e3d7dff5c809ed18", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4034, "upload_time": "2016-08-15T19:31:08", "url": "https://files.pythonhosted.org/packages/0a/fe/c9d2e0ca396fc7b35953b990a69b03088c3497d87886f00b2282835e4df3/sphinx-django-command-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "1ea9f182e4d0b6f5621f1fc4e3712b5a", "sha256": "837adc9146c51c7a35768e9b2f3f544056a39d0616d72550f957282cd8c678fa" }, "downloads": -1, "filename": "sphinx-django-command-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1ea9f182e4d0b6f5621f1fc4e3712b5a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4118, "upload_time": "2016-08-15T22:56:27", "url": "https://files.pythonhosted.org/packages/ef/85/3a520be5d30f6b65ab60a76018ed40226ddc6b305f6b59987eb4879d5ac4/sphinx-django-command-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1ea9f182e4d0b6f5621f1fc4e3712b5a", "sha256": "837adc9146c51c7a35768e9b2f3f544056a39d0616d72550f957282cd8c678fa" }, "downloads": -1, "filename": "sphinx-django-command-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1ea9f182e4d0b6f5621f1fc4e3712b5a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4118, "upload_time": "2016-08-15T22:56:27", "url": "https://files.pythonhosted.org/packages/ef/85/3a520be5d30f6b65ab60a76018ed40226ddc6b305f6b59987eb4879d5ac4/sphinx-django-command-0.1.3.tar.gz" } ] }