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.

Metadata

Release files for docserver 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docserver 0.2.1
File	Size	Uploaded	Provenance	Actions
docserver-0.2.1.tar.gz	11.1 kB	Oct 7, 2019	Without provenance	Details for docserver-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for docserver 0.2.1
File	Interpreter	ABI	Platform	Actions Reset
docserver-0.2.1-py3-none-any.whl 24.8 kB Oct 7, 2019 Without provenance	Python 3	none	any	Details for docserver-0.2.1-py3-none-any.whl

Total release size: 35.9 kB

Release files / docserver-0.2.1.tar.gz

Download URL	docserver-0.2.1.tar.gz
Size	11.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`9c2f7d20c0b62f6514b958ab261e9de02d1aa46eccf4b2198af87ac12071e494`
BLAKE2b-256 checksum How to use checksums	`71508998ec578feddd88177106c08548133312ac5ee018dc90820e571df6cafb`
Upload date	Oct 7, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.22.0`

Release files / docserver-0.2.1-py3-none-any.whl

Download URL	docserver-0.2.1-py3-none-any.whl
Size	24.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8b71431c28f535b868af01444bf00c5abc8d2ee9a5b5ed0890ecbc3160282b9a`
BLAKE2b-256 checksum How to use checksums	`5596b5b953de70aa72e046f3f38a6f1a2b1c74544c3db5ecad9eb71cd5e25cb1`
Upload date	Oct 7, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.22.0`

Security for docserver 0.2.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.1 This release

Oct 7, 2019 2 release files No provenance

0.1.0

Aug 23, 2013 1 release file No provenance

docserver 0.2.1