Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

setuptools command for uploading Sphinx documentation to PyPI

Project Description

This package contains a setuptools command for uploading Sphinx documentation to the Python Package Index (PyPI) at the dedicated URL

The upload_sphinx command

upload_sphinx will create the necessary zip file out of an arbitrary documentation directory and posts it to the correct URL.

It’s also loosely based on Sphinx’ own setuptools command build_sphinx which allows to easily build documentation from the command line.

The upload_sphinx command has the following options:

  • --repository (-r): url of repository [default:]
  • --show-response: display full response text from server
  • --upload-dir: directory to upload


Assuming there is an Example package with Sphinx documentation to be uploaded to, with the following structure:

|-- setup.cfg
|-- docs
|   |-- build
|   |   `-- html
|   |--
|   |-- index.txt
|   `-- tips_tricks.txt

As with any other setuptools based command, you can define useful defaults in the setup.cfg of your Python package. The following snippet shows how to set the option defaults of the build_sphinx and upload_sphinx commands:

source-dir = docs/
build-dir  = docs/build
all_files  = 1

upload-dir = docs/build/html

To build and upload the Sphinx documentation you are now able to run:

$ python build_sphinx
$ python upload_sphinx

Alternatively, you can of course just pass the appropriate options directly to the commands:

$ python build_sphinx --source-dir=docs/ --build-dir=docs/build --all-files
$ python setup.y upload_sphinx --upload-dir=docs/build/html

Release History

This version
History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(2.4 kB) Copy SHA256 Hash SHA256
Source None Oct 1, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers