Skip to content
Documentation server
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.coveragerc
.gitignore
INTERNALS
LICENSE
README.rst
docserver.py
pyproject.toml
tests.py
tox.ini

README.rst

docserver - a documentation server in the vein of PyPI

Author: Keith Gaughan

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.

You can’t perform that action at this time.