Lightweight, user-friendly PyPI-style documentation server
Project description
docserver is a lightweight, user-friendly documentation server in the style of PyPI and Read the Docs.
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.
docserver plays nice with Paste. Here’s an example paste configuration:
[composite:main] use = egg:Paste#urlmap / = docserver [app:docserver] use = egg:docserver ; Set 'store' to configure a custom bundle store. ; Set 'template' to configure a custom frontpage template. [server:main] use = egg:Paste#http host = 127.0.0.1 port = 8080
Reskinning
If you want to use a skin other than the ugly default skin, there’s a marginally prettier one at extra/frontpage.html in the package.
The template engine used is pystache.
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.