Download 
| Authors: | Roman Mohr <roman@fenkhuber.at> |
|---|---|
| Version: | 0.1.0 |
| Date: | 2013-08-16 |
| Code: | https://github.com/rmohr/sphinx-server |
Table of Contents
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
successful builds
Builds marked with
a lock icon are only available via PyPM to users with a current