{ "info": { "author": "Michael Droettboom", "author_email": "mdroe@stsci.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Plugins", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Topic :: Software Development :: Documentation" ], "description": "stsci.sphinxext\n===============\n\n:author: Michael Droettboom, 2011\n\nPurpose\n-------\n\nThis project contains extensions to Sphinx to build documentation from STScI.\n\nPrerequisites\n-------------\n\n- Sphinx 0.6.3 or later, and its dependencies\n\n- numpydoc - provides support for Numpy-style docstring syntax\n\n - The version shipped with Numpy 1.4.0 or later is required\n\n- matplotlib - provides matplotlib extensions for inline plotting\n\nThese requirements are not listed in the installation requirements in the\nmetadata simply because numpy and matplotlib in particular are large and not\neasy to deal with, so trying to install a Sphinx theme should not have the\nside-effect of trying to install these prerequisites as well.\n\nUsage\n-----\n\nThese instructions only cover changes from the standard Sphinx\ninstructions.\n\nCreate a new tree for your Sphinx documentation, using\nsphinx_quickstart, as described in the `Sphinx introduction\n`_.\n\nImport the stsci_sphinx customizations into your project's `conf.py`\nby inserting the following line at the top::\n\n from stsci.sphinxext.conf import *\n\nThe \"extensions\" line in your `conf.py` should also be modified so it\ndoesn't override the extensions defined by stsci.sphinxext. For\nexample, change::\n\n extensions = ['sphinx.ext.autodoc']\n\nto::\n\n extensions += ['sphinx.ext.autodoc']\n\nAlso, comment out the 'html_theme' line, so your project will use the\nstsci.sphinxext one.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.stsci.edu/resources/software_hardware/stsci_python", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "stsci.sphinxext", "package_url": "https://pypi.org/project/stsci.sphinxext/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/stsci.sphinxext/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.stsci.edu/resources/software_hardware/stsci_python" }, "release_url": "https://pypi.org/project/stsci.sphinxext/1.2.1/", "requires_dist": null, "requires_python": null, "summary": "A set of tools and templates to customize Sphinx for use in STScI projects", "version": "1.2.1" }, "last_serial": 1901274, "releases": { "1.1": [ { "comment_text": "", "digests": { "md5": "3355115132330439ecfd1433831ee253", "sha256": "0f156b65cc5c0812661de498bece1f0696114c110334992620f9921892fc315f" }, "downloads": -1, "filename": "stsci.sphinxext-1.1.tar.gz", "has_sig": false, "md5_digest": "3355115132330439ecfd1433831ee253", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 54842, "upload_time": "2011-08-31T22:15:33", "url": "https://files.pythonhosted.org/packages/69/15/007f82438485a42fa7bb28e0d7be6e56688e2452559cc2a2783a9f175922/stsci.sphinxext-1.1.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "d23f6ad057a4af86a6ce3771bddb1754", "sha256": "17ae92d3ee683b0ac11a0f9a8b3862207aa7790f188147dd0de6a99721776f5a" }, "downloads": -1, "filename": "stsci.sphinxext-1.2.1.tar.gz", "has_sig": false, "md5_digest": "d23f6ad057a4af86a6ce3771bddb1754", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 75591, "upload_time": "2013-05-01T19:26:52", "url": "https://files.pythonhosted.org/packages/90/be/78856cac57dc4a341760c433bdf2ee35e2200a68f0f5ef2813e72292024e/stsci.sphinxext-1.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d23f6ad057a4af86a6ce3771bddb1754", "sha256": "17ae92d3ee683b0ac11a0f9a8b3862207aa7790f188147dd0de6a99721776f5a" }, "downloads": -1, "filename": "stsci.sphinxext-1.2.1.tar.gz", "has_sig": false, "md5_digest": "d23f6ad057a4af86a6ce3771bddb1754", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 75591, "upload_time": "2013-05-01T19:26:52", "url": "https://files.pythonhosted.org/packages/90/be/78856cac57dc4a341760c433bdf2ee35e2200a68f0f5ef2813e72292024e/stsci.sphinxext-1.2.1.tar.gz" } ] }