Skip to main content

simple wsgi sphinx server

Project description

sphinx-server is a minimal sphinx documentation hosting server. It is compatible with Sphinx-PyPi-upload. To view the documentation static3 is used.

Installation and Usage

Install sphinx-server:

pip install sphinx-server

or from GitHub:

git clone git://
cd sphinx-server
pip install .


Download the WSGI HTTP Server:

pip install gunicorn

Run the server:

gunicorn -w 1 'sphinxserver:app(home="root/folder")' -b

Upload the documentation of your project:

cd /your/project/path
python upload_sphinx --repository=

Browse the documentation:



Alternatively spinx-server can be run via pastedeploy. An example.ini might look like this:

use = egg:sphinx-server#main
home= ~/sphinx-docs

use = egg:gunicorn#main
host =
port = 9000
workers = 5
accesslog = -

Install the WSGI HTTP Server:

pip install gunicorn pastedeploy

Run the server:

gunicorn_paster example.ini

Project details

Release history Release notifications

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
sphinx-server-0.1.0.tar.gz (17.3 kB) Copy SHA256 hash SHA256 Source None Aug 16, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page