Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

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

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
docserver-0.1.0.tar.gz (11.0 kB) Copy SHA256 hash SHA256 Source None Aug 23, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page