{ "info": { "author": "Rick van Hattem", "author_email": "wolph@wol.ph", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Setuptools Plugin", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Sphinx-PyPI-upload\n==================\n\nThis package contains a `setuptools`_ command for uploading `Sphinx`_\ndocumentation to the `Python Package Index`_ (PyPI) at the dedicated URL\npackages.python.org. It was forked from the similarly named script from Jannis\nLeidel which has not been updated since 2009.\n\nHomepage: https://github.com/WoLpH/sphinx-pypi-upload\n\n.. _setuptools: http://pypi.python.org/pypi/setuptools\n.. _Sphinx: http://sphinx.pocoo.org/\n.. _`Python Package Index`: http://pypi.python.org/\n\n\nThe ``upload_sphinx`` command\n------------------------------\n\n``upload_sphinx`` will create the necessary zip file out of an arbitrary \ndocumentation directory and posts it to the correct URL.\n\nIt's also loosely based on Sphinx' own setuptools command build_sphinx_\nwhich allows to easily build documentation from the command line.\n\nThe ``upload_sphinx`` command has the following options:\n\n- ``--repository (-r)``:\n url of repository [default: http://pypi.python.org/pypi]\n\n- ``--show-response``:\n display full response text from server\n\n- ``--upload-dir``:\n directory to upload\n\n.. _build_sphinx: http://bitbucket.org/birkenfeld/sphinx/src/tip/sphinx/setup_command.py\n\nExample\n--------\n\nAssuming there is an ``Example`` package with Sphinx documentation to be\nuploaded to http://packages.python.org, with the following structure::\n\n Example/\n |-- example.py\n |-- setup.cfg\n |-- setup.py\n |-- docs\n | |-- build\n | | `-- html\n | |-- conf.py\n | |-- index.txt\n | `-- tips_tricks.txt\n\nAs with any other setuptools based command, you can define useful defaults in\nthe setup.cfg of your Python package. The following snippet shows how to set\nthe option defaults of the ``build_sphinx`` and ``upload_sphinx`` setup.py \ncommands::\n\n [build_sphinx]\n source-dir = docs/\n build-dir = docs/build\n all_files = 1\n\n [upload_sphinx]\n upload-dir = docs/build/html\n\nTo build and upload the Sphinx documentation you are now able to run::\n\n $ python setup.py build_sphinx\n $ python setup.py upload_sphinx\n\nAlternatively, you can of course just pass the appropriate options directly\nto the commands::\n\n $ python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/build --all-files\n $ python setup.y upload_sphinx --upload-dir=docs/build/html", "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/WoLpH/sphinx-pypi-upload", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "Sphinx-PyPI-upload-2", "package_url": "https://pypi.org/project/Sphinx-PyPI-upload-2/", "platform": "any", "project_url": "https://pypi.org/project/Sphinx-PyPI-upload-2/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/WoLpH/sphinx-pypi-upload" }, "release_url": "https://pypi.org/project/Sphinx-PyPI-upload-2/0.2.2/", "requires_dist": null, "requires_python": null, "summary": "Setuptools command for uploading Sphinx documentation to the PyPI", "version": "0.2.2" }, "last_serial": 1959276, "releases": { "0.2.2": [ { "comment_text": "", "digests": { "md5": "c52997c9dc4ac5b46a8925ff15256602", "sha256": "2cae599a92482fbf2ba7d7a8cce13d8247de8ac3f133e73960017bcf242f369c" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-2-0.2.2.tar.gz", "has_sig": false, "md5_digest": "c52997c9dc4ac5b46a8925ff15256602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4392, "upload_time": "2016-02-16T13:00:00", "url": "https://files.pythonhosted.org/packages/a5/93/6b2d20dafd257a41d1ff8287b7a878109c97ba52ce7da1dd0d85132a8781/Sphinx-PyPI-upload-2-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c52997c9dc4ac5b46a8925ff15256602", "sha256": "2cae599a92482fbf2ba7d7a8cce13d8247de8ac3f133e73960017bcf242f369c" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-2-0.2.2.tar.gz", "has_sig": false, "md5_digest": "c52997c9dc4ac5b46a8925ff15256602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4392, "upload_time": "2016-02-16T13:00:00", "url": "https://files.pythonhosted.org/packages/a5/93/6b2d20dafd257a41d1ff8287b7a878109c97ba52ce7da1dd0d85132a8781/Sphinx-PyPI-upload-2-0.2.2.tar.gz" } ] }