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

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://github.com/rmohr/sphinx-server.git
cd sphinx-server
pip install .

gunicorn

Download the WSGI HTTP Server:

pip install gunicorn

Run the server:

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

Upload the documentation of your project:

cd /your/project/path
python setup.py upload_sphinx --repository=http://127.0.0.1:8080

Browse the documentation:

firefox http://127.0.0.1:8080/your_project_name/

pastedeploy

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

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

[server:main]
use = egg:gunicorn#main
host = 0.0.0.0
port = 9000
workers = 5
accesslog = -

Install the WSGI HTTP Server:

pip install gunicorn pastedeploy

Run the server:

gunicorn_paster example.ini
Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinx-server-0.1.0.tar.gz (17.3 kB) Copy SHA256 Checksum SHA256 Source Aug 16, 2013

Supported By

WebFaction WebFaction Technical Writing 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 Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting