{ "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\r\n==================\r\n\r\nThis package contains a `setuptools`_ command for uploading `Sphinx`_\r\ndocumentation to the `Python Package Index`_ (PyPI) at the dedicated URL\r\npackages.python.org.\r\n\r\n.. _setuptools: http://pypi.python.org/pypi/setuptools\r\n.. _Sphinx: http://sphinx.pocoo.org/\r\n.. _`Python Package Index`: http://pypi.python.org/\r\n\r\n\r\nThe ``upload_sphinx`` command\r\n------------------------------\r\n\r\n``upload_sphinx`` will create the necessary zip file out of an arbitrary \r\ndocumentation directory and posts it to the correct URL.\r\n\r\nIt's also loosely based on Sphinx' own setuptools command build_sphinx_\r\nwhich allows to easily build documentation from the command line.\r\n\r\nThe ``upload_sphinx`` command has the following options:\r\n\r\n- ``--repository (-r)``:\r\n url of repository [default: http://pypi.python.org/pypi]\r\n\r\n- ``--show-response``:\r\n display full response text from server\r\n\r\n- ``--upload-dir``:\r\n directory to upload\r\n\r\n.. _build_sphinx: http://bitbucket.org/birkenfeld/sphinx/src/tip/sphinx/setup_command.py\r\n\r\nExample\r\n--------\r\n\r\nAssuming there is an ``Example`` package with Sphinx documentation to be\r\nuploaded to http://packages.python.org, with the following structure::\r\n\r\n Example/\r\n |-- example.py\r\n |-- setup.cfg\r\n |-- setup.py\r\n |-- docs\r\n | |-- build\r\n | | `-- html\r\n | |-- conf.py\r\n | |-- index.txt\r\n | `-- tips_tricks.txt\r\n\r\nAs with any other setuptools based command, you can define useful defaults in\r\nthe setup.cfg of your Python package. The following snippet shows how to set\r\nthe option defaults of the ``build_sphinx`` and ``upload_sphinx`` setup.py \r\ncommands::\r\n\r\n [build_sphinx]\r\n source-dir = docs/\r\n build-dir = docs/build\r\n all_files = 1\r\n\r\n [upload_sphinx]\r\n upload-dir = docs/build/html\r\n\r\nTo build and upload the Sphinx documentation you are now able to run::\r\n\r\n $ python setup.py build_sphinx\r\n $ python setup.py upload_sphinx\r\n\r\nAlternatively, you can of course just pass the appropriate options directly\r\nto the commands::\r\n\r\n $ python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/build --all-files\r\n $ python setup.py 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": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "Sphinx-PyPI-upload", "package_url": "https://pypi.org/project/Sphinx-PyPI-upload/", "platform": "any", "project_url": "https://pypi.org/project/Sphinx-PyPI-upload/", "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-upload/0.2.1/", "requires_dist": null, "requires_python": null, "summary": "setuptools command for uploading Sphinx documentation to PyPI", "version": "0.2.1" }, "last_serial": 638544, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "21ace7d08553d14184368413ddc07fcc", "sha256": "9b5f04ee4b0e5686e1c6973523188a141021f71b32e9bcbeccf496850e2a11a3" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-0.1.1.tar.gz", "has_sig": true, "md5_digest": "21ace7d08553d14184368413ddc07fcc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3532, "upload_time": "2009-07-13T02:08:51", "url": "https://files.pythonhosted.org/packages/33/ad/6fd69fde6685f17dd56f4d6948d7227d11c6f08c5342bda84517a688c582/Sphinx-PyPI-upload-0.1.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "5809de8fa988478773b35f11b5d72fa0", "sha256": "38a0d73dc13d324dd0b7830d2b323e217c165eb624e9a6e6116e3f56cba1c305" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-0.2.tar.gz", "has_sig": true, "md5_digest": "5809de8fa988478773b35f11b5d72fa0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3495, "upload_time": "2009-07-13T10:34:49", "url": "https://files.pythonhosted.org/packages/d2/e7/5b8e0eab8b5eeceb237e9cc065f022dace6900a4cac6ea1cfe192ec29ed2/Sphinx-PyPI-upload-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "b9f1df5c8443197e4d49abbba1cfddc4", "sha256": "5f919a47ce7a7e6028dba809de81ae1297ac192347cf6fc54efca919d4865159" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-0.2.1.tar.gz", "has_sig": false, "md5_digest": "b9f1df5c8443197e4d49abbba1cfddc4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4555, "upload_time": "2009-08-25T13:47:21", "url": "https://files.pythonhosted.org/packages/3e/68/723a5656d0fa705c1eae4c546ded85882fb4b3241b079aeab66e92513416/Sphinx-PyPI-upload-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b9f1df5c8443197e4d49abbba1cfddc4", "sha256": "5f919a47ce7a7e6028dba809de81ae1297ac192347cf6fc54efca919d4865159" }, "downloads": -1, "filename": "Sphinx-PyPI-upload-0.2.1.tar.gz", "has_sig": false, "md5_digest": "b9f1df5c8443197e4d49abbba1cfddc4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4555, "upload_time": "2009-08-25T13:47:21", "url": "https://files.pythonhosted.org/packages/3e/68/723a5656d0fa705c1eae4c546ded85882fb4b3241b079aeab66e92513416/Sphinx-PyPI-upload-0.2.1.tar.gz" } ] }