{ "info": { "author": "Jannis Leidel", "author_email": "jannis@leidel.info", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "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.\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": "http://bitbucket.org/jezdez/sphinx-pypi-upload/downloads/", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/jezdez/sphinx-pypi-upload/", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "Sphinx-PyPI-upload3", "package_url": "https://pypi.org/project/Sphinx-PyPI-upload3/", "platform": "any", "project_url": "https://pypi.org/project/Sphinx-PyPI-upload3/", "project_urls": { "Download": "http://bitbucket.org/jezdez/sphinx-pypi-upload/downloads/", "Homepage": "http://bitbucket.org/jezdez/sphinx-pypi-upload/" }, "release_url": "https://pypi.org/project/Sphinx-PyPI-upload3/0.2.2/", "requires_dist": null, "requires_python": null, "summary": "setuptools command for uploading Sphinx documentation to PyPI", "version": "0.2.2" }, "last_serial": 2186480, "releases": { "0.2.2": [ { "comment_text": "", "digests": { "md5": "a33dd2c90887ac7a523cfa4254d7e3d9", "sha256": "fb627dcedb708821aaf63eabcc1697f54904d8081d39c1dd8c1ad1689c3bf2b7" }, "downloads": -1, "filename": "Sphinx-PyPI-upload3-0.2.2.win32.exe", "has_sig": false, "md5_digest": "a33dd2c90887ac7a523cfa4254d7e3d9", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 198491, "upload_time": "2016-06-25T09:10:32", "url": "https://files.pythonhosted.org/packages/b5/44/a865664f8e15ed51cf432ea834797967ac7bb7925a7262dd23bc8b21f306/Sphinx-PyPI-upload3-0.2.2.win32.exe" }, { "comment_text": "", "digests": { "md5": "1fb10d1f1658a9cee5b5f7bad4d315bb", "sha256": "414dc4c429ac5236692397083cd023b97e8dd3a5b5020b3c66450f09f21fd4a6" }, "downloads": -1, "filename": "Sphinx-PyPI-upload3-0.2.2.zip", "has_sig": false, "md5_digest": "1fb10d1f1658a9cee5b5f7bad4d315bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8058, "upload_time": "2016-06-25T09:10:21", "url": "https://files.pythonhosted.org/packages/dc/74/a890fc80a2f55d2fbba02faf4ffb2d16aca781cc0e597890b758027f1460/Sphinx-PyPI-upload3-0.2.2.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a33dd2c90887ac7a523cfa4254d7e3d9", "sha256": "fb627dcedb708821aaf63eabcc1697f54904d8081d39c1dd8c1ad1689c3bf2b7" }, "downloads": -1, "filename": "Sphinx-PyPI-upload3-0.2.2.win32.exe", "has_sig": false, "md5_digest": "a33dd2c90887ac7a523cfa4254d7e3d9", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 198491, "upload_time": "2016-06-25T09:10:32", "url": "https://files.pythonhosted.org/packages/b5/44/a865664f8e15ed51cf432ea834797967ac7bb7925a7262dd23bc8b21f306/Sphinx-PyPI-upload3-0.2.2.win32.exe" }, { "comment_text": "", "digests": { "md5": "1fb10d1f1658a9cee5b5f7bad4d315bb", "sha256": "414dc4c429ac5236692397083cd023b97e8dd3a5b5020b3c66450f09f21fd4a6" }, "downloads": -1, "filename": "Sphinx-PyPI-upload3-0.2.2.zip", "has_sig": false, "md5_digest": "1fb10d1f1658a9cee5b5f7bad4d315bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8058, "upload_time": "2016-06-25T09:10:21", "url": "https://files.pythonhosted.org/packages/dc/74/a890fc80a2f55d2fbba02faf4ffb2d16aca781cc0e597890b758027f1460/Sphinx-PyPI-upload3-0.2.2.zip" } ] }