sphinx-server - A minimalistic server for uploading and viewing sphinx documentation
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
Metadata
Release files for sphinx-server 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-server-0.1.0.tar.gz | 17.3 kB | Without provenance | Details for sphinx-server-0.1.0.tar.gz |
Release files / sphinx-server-0.1.0.tar.gz
| Download URL | sphinx-server-0.1.0.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f1b1cabe44971c74a61a397dceeb5be0b4061618034d26ce5a7db647489c142e
|
|
BLAKE2b-256 checksum How to use checksums |
4dbaafefba1ccfbf9ee459f042e3589f358ed010495d9a4e55aec1145db7f401
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinx-server 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.