Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Automatic HTTP API documentation for TiddlyWeb

Project Description

A serialization which provides documentation of the request methods and serializations for all the resources available from the current TiddlyWeb instance.

That is: for any existing resource if you get it as text/x-tiddlyweb-docs this code will automatically generate documentation about this thing.

So, for example http://example.com/bags/foo/tiddlers.x-doc will list the serializations and HTTP methods available at that URI.

The motivation for this is to cause lack-of-documentation shame.

Install by adding tiddlywebplugins.docs to system_plugins in tiddlywebconfig.py.

Copyright 2011 Chris Dent <cdent@peermore.com> BSD License

Release History

Release History

This version
History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
tiddlywebplugins.docs-0.5.tar.gz (7.1 kB) Copy SHA256 Checksum SHA256 Source Nov 10, 2011

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting