Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project details


Release history Release notifications

Download files

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

Files for sphinx-server, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-server-0.1.0.tar.gz (17.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

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