How to install docserver
- Download and install ActivePython
- Open Command Prompt
- Type
pypm install docserver
Lastest release
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 :mod:`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.
Internals
Submission
Uploads work in the same fashion supported by PyPI and Sphinx-PyPI-upload. You submit documentation by performing a POST request with the mimetype multipart/form-data. There are three fields: :action, which has the value doc_upload; name, which contains the name of the package; and content, which contains a Zip file of the documentation.
Name normalisation
Names are converted to lowercase and any underscores and fullstops are converted to hyphens. Runs of multiple hyphen are collapsed down to single hyphens. Leading and trailing hyphens are rejected. After normalisation, any names that are not at least two characters long and contain characters other than alphanumerics and hyphens are rejected.
Storage
Zip files are stored as is in a shallow directory hierarchy where the name of a directory is based on the first two characters of the packages it contains. Thus the documentation for the dbkit package would be stored as db/dbkit.zip.