A PyPI-style documentation server.
Project description
docserver is a lightweight, user-friendly documentation server.
Installation
To install from PyPI:
$ pip install docserver
You can use docserver straight out of the box by running the module:
$ python -m docserver
And to show the help:
$ python -m docserver --help
The WSGI app itself is exposed as docserver.DocServer. If you want to use a bundle store path or frontpage template other than the default, you can set the environment variables DOCSERVER_STORE and DOCSERVER_TEMPLATE respectively.
Reskinning
If you want to use a skin other than the default skin, you can use he default skin as the basis for a new one. To print out the default skin:
python -m docserver --print-template
The template engine used is pystache.
Testing
Use the following to run the test suite:
$ python setup.py test
If you’re considering contributing back, make sure you run the testsuite against all the supported versions of Python. You can use tox to do this:
$ tox
Or with detox:
$ detox
To install additional versions of Python for testing, I recommend pyenv.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docserver-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b71431c28f535b868af01444bf00c5abc8d2ee9a5b5ed0890ecbc3160282b9a |
|
MD5 | 369a92351e5ac2b1ffad1a89178f3006 |
|
BLAKE2b-256 | 5596b5b953de70aa72e046f3f38a6f1a2b1c74544c3db5ecad9eb71cd5e25cb1 |