{ "info": { "author": "Joshua Griffin Dunn", "author_email": "joshua.g.dunn@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Plugins", "Environment :: Web Environment", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Documentation :: Sphinx", "Topic :: Software Development :: Documentation", "Topic :: Text Processing", "Topic :: Utilities" ], "description": "Welcome to `sphinxcontrib-argdoc`\r\n=================================\r\n\r\nIntroduction\r\n------------\r\n\r\n`sphinxcontrib-argdoc `_\r\nis an extension for the `Sphinx `_\r\ndocumentation engine.\r\n\r\nIt automatically generates tables describing command-line arguments\r\nfor executable scripts written in Python, and inserts those tables\r\ninto the ``:automodule:`` documentation generated for the scripts by\r\nthe Sphinx extension `autodoc `_.\r\n\r\nThe only requirements are:\r\n\r\n 1. The executable scripts use the Python\r\n `argparse `_ module\r\n for argument parsing.\r\n\r\n 2. The `rst` documentation stub file for the scripts include\r\n the ``:automodule:`` directive (which they will, by default,\r\n if you use `sphinx-apidoc`).\r\n\r\nFor more info, detailed instructions, and examples, see the\r\n`sphinxcontrib-argdoc documentation `_.\r\n\r\n\r\nInstallation and use\r\n--------------------\r\n\r\n`sphinxcontrib-argdoc `_\r\nmay be installed from `PyPI `_\r\nusing `pip `_. Alternatively,\r\nyou can clone the development version into your ``PYTHONPATH``.\r\n\r\nTo use `sphinxcontrib-argdoc `_,\r\nsimply add `'sphinxcontrib.argdoc'` to the list of extensions in your project's\r\nSphinx configuration file `conf.py `_:\r\n\r\n .. code-block:: python\r\n\r\n # somewhere in conf.py\r\n extensions = ['sphinxcontrib.argdoc',\r\n 'another_extension',\r\n 'some_other_extension'\r\n ]\r\n\r\n\r\nTests\r\n-----\r\n\r\nTests are written using `nose `_,\r\nand may be found in the subpackage `sphinxcontrib.argdoc.test`. To run the tests,\r\ntype from the terminal:\r\n\r\n .. code-block:: shell\r\n\r\n $ nosetests sphinxcontrib.argdoc.test\r\n\r\n\r\nAuthors\r\n-------\r\n\r\n - `Joshua Griffin Dunn `_\r\n\r\n\r\nLicense\r\n-------\r\n`sphinxcontrib-argdoc` is licensed under the\r\n`BSD 3-Clause License `_.", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-argdoc", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://sphinxcontrib-argdoc.readthedocs.org/en/latest/index.html", "keywords": "sphinx documentation argparse command-line autodoc", "license": "BSD 3-Clause", "maintainer": "Joshua Griffin Dunn", "maintainer_email": "joshua.g.dunn@gmail.com", "name": "sphinxcontrib-argdoc", "package_url": "https://pypi.org/project/sphinxcontrib-argdoc/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-argdoc/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-argdoc", "Homepage": "http://sphinxcontrib-argdoc.readthedocs.org/en/latest/index.html" }, "release_url": "https://pypi.org/project/sphinxcontrib-argdoc/0.1.3/", "requires_dist": [ "sphinx (>=1.3.1)", "autodoc (>=0.3)" ], "requires_python": null, "summary": "Sphinx", "version": "0.1.3" }, "last_serial": 1682707, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "5555b2490cfce1ffabb35aee06e3b9b6", "sha256": "7fdad637d7a5da551bbd55a24ff6e608a623854f95eceb2de578ae5ac78c1e4b" }, "downloads": -1, "filename": "sphinxcontrib_argdoc-0.1.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "5555b2490cfce1ffabb35aee06e3b9b6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 52008, "upload_time": "2015-07-08T02:29:16", "url": "https://files.pythonhosted.org/packages/9a/9f/487595def57530cf291adb89c2b9cff91bb78b7848d70076e907fac43242/sphinxcontrib_argdoc-0.1.1-py2.py3-none-any.whl" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "678ba21a4a81f969ab24affdc35c604a", "sha256": "8602519e1863e0e62471e181cd80e5e79c3495a43ac7cf6718198880835f51ae" }, "downloads": -1, "filename": "sphinxcontrib_argdoc-0.1.2-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "678ba21a4a81f969ab24affdc35c604a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 51865, "upload_time": "2015-07-08T04:22:13", "url": "https://files.pythonhosted.org/packages/44/f5/1598392205c74ea51b49fc1184e2ccb2afa7aca55fe14f845d0d26789da1/sphinxcontrib_argdoc-0.1.2-py2.py3-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "b14a7763a6cc1a13ba16843484f41ab3", "sha256": "13485163bbaca777eb58fd53e2948531ffc4b71221b91644db889ab552724be7" }, "downloads": -1, "filename": "sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "b14a7763a6cc1a13ba16843484f41ab3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 51900, "upload_time": "2015-07-08T20:45:28", "url": "https://files.pythonhosted.org/packages/b8/9e/fad1332271473652d7702dfc89f76017cb6ef854581b3582c0ecdfe79f07/sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc0837696f6f264de602a4f8566be083", "sha256": "a062b96bca3c1cb9b2c4cfeed09dd4d78d32ea8ddb2c38769df22671a2c78439" }, "downloads": -1, "filename": "sphinxcontrib-argdoc-0.1.3.tar.gz", "has_sig": true, "md5_digest": "cc0837696f6f264de602a4f8566be083", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22856, "upload_time": "2015-08-18T16:53:10", "url": "https://files.pythonhosted.org/packages/22/a7/e167af1c16d0640ac41a0d45d443307271c346ea9bccba1897809a74e87e/sphinxcontrib-argdoc-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b14a7763a6cc1a13ba16843484f41ab3", "sha256": "13485163bbaca777eb58fd53e2948531ffc4b71221b91644db889ab552724be7" }, "downloads": -1, "filename": "sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "b14a7763a6cc1a13ba16843484f41ab3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 51900, "upload_time": "2015-07-08T20:45:28", "url": "https://files.pythonhosted.org/packages/b8/9e/fad1332271473652d7702dfc89f76017cb6ef854581b3582c0ecdfe79f07/sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc0837696f6f264de602a4f8566be083", "sha256": "a062b96bca3c1cb9b2c4cfeed09dd4d78d32ea8ddb2c38769df22671a2c78439" }, "downloads": -1, "filename": "sphinxcontrib-argdoc-0.1.3.tar.gz", "has_sig": true, "md5_digest": "cc0837696f6f264de602a4f8566be083", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22856, "upload_time": "2015-08-18T16:53:10", "url": "https://files.pythonhosted.org/packages/22/a7/e167af1c16d0640ac41a0d45d443307271c346ea9bccba1897809a74e87e/sphinxcontrib-argdoc-0.1.3.tar.gz" } ] }