Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython
INSTALL>
pypm install docserver

How to install docserver

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install docserver
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
Windows (64-bit)
Mac OS X (10.5+)
Linux (32-bit)
Linux (64-bit)
0.1.0 Available View build log
Web
 
Author
License
Apache Licence v2.0
Dependencies
Imports
Lastest release
version 0.1.0 on Jan 9th, 2014

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.

System Message: ERROR/3 (<string>, line 26); backlink

Unknown interpreted text role "mod".

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.

Testing

Use the following to run the test suite:

$ python setup.py test

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.

Subscribe to package updates

Last updated Jan 9th, 2014

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.