Skip to main content

A PyPI-style documentation server.

Project description


Keith Gaughan

docserver is a lightweight, user-friendly documentation server.


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.


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.


Use the following to run the test suite:

$ python 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

Download files

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

Source Distribution

docserver-0.2.1.tar.gz (11.1 kB view hashes)

Uploaded Source

Built Distribution

docserver-0.2.1-py3-none-any.whl (24.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page