{ "info": { "author": "pysphinxdoc developers", "author_email": "antoine.grigis@cea.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: X11 Applications :: Qt", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Scientific/Engineering", "Topic :: Utilities" ], "description": "============\npysphinxdoc\n============\n\nPysphinxdoc is a tool for generating automatically API documentation\nfor Python modules, based on their reStructuredText docstrings, using the\n`sikit-learn `_ theme,\n`Bootstrap `_ and\n`Sphinx `_.\nVisit this `module documentation `_\nfor a live example.\n\nHere is an exemple to generate the 'pysphinxdoc' module documentation:\nfirst execute 'sphinxdoc -v 2 -p $HOME/git/pysphinxdoc/ -n pysphinxdoc\n-o $HOME/git/pysphinxdoc/doc/' and then in the $HOME/git/pysphinxdoc/doc/\nfolder 'make raw-html'.\n\nExpect a '$name_module/doc/source/_static' folder containing a logo named\n'$name_module.png' and an 'carousel' subfolder containing a list of images\nto be displayed in the index banner of the site.\n\nThe documentation is generated from the reStructuredText docstrings of each\nmodule, function or class.\n\nIn order to find module information, an 'info.py' module is expected at the\nroot of the module with mandatory keys:\n\n * NAME: the name of the module.\n * DESCRIPTION: the module short description that will be displayed in the\n banner.\n * LONG_DESCRIPTION: the index page content.\n * URL: the module URL.\n * AUTHOR: the author of the module.\n * AUTHOR_EMAIL: the author e-mail.\n * __version__: the module version.\n\nAnd optional keys:\n\n * EXTRANAME: a name that will be displayed in the last element of the\n navbar (default 'PYSPHINXDOC').\n * EXTRAURL: the associated URL (default the pySphinxDoc URL).", "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/AGrigis/pysphinxdoc", "keywords": null, "license": "CeCILL-B", "maintainer": null, "maintainer_email": null, "name": "pysphinxdoc", "package_url": "https://pypi.org/project/pysphinxdoc/", "platform": "OS Independent", "project_url": "https://pypi.org/project/pysphinxdoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/AGrigis/pysphinxdoc" }, "release_url": "https://pypi.org/project/pysphinxdoc/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "[pysphinxdoc] API Documentation Generation Tool.", "version": "1.0.0" }, "last_serial": 2061806, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "f7a7849437162149c88c6add85077392", "sha256": "d4d15343222697c3436c0f63aa193fe2da41d0fd9c1501e7ff3ab9c164e5c327" }, "downloads": -1, "filename": "pysphinxdoc-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f7a7849437162149c88c6add85077392", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 301227, "upload_time": "2016-04-13T13:20:44", "url": "https://files.pythonhosted.org/packages/e8/72/f06f51c72758fad8791dd567cd0970d74fd7263b3fcfabacf80206eeee6f/pysphinxdoc-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f7a7849437162149c88c6add85077392", "sha256": "d4d15343222697c3436c0f63aa193fe2da41d0fd9c1501e7ff3ab9c164e5c327" }, "downloads": -1, "filename": "pysphinxdoc-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f7a7849437162149c88c6add85077392", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 301227, "upload_time": "2016-04-13T13:20:44", "url": "https://files.pythonhosted.org/packages/e8/72/f06f51c72758fad8791dd567cd0970d74fd7263b3fcfabacf80206eeee6f/pysphinxdoc-1.0.0.tar.gz" } ] }