skip to navigation
skip to content

tiddlywebplugins.docs 0.5

Automatic HTTP API documentation for TiddlyWeb

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

 
File Type Py Version Uploaded on Size
tiddlywebplugins.docs-0.5.tar.gz (md5) Source 2011-11-10 6KB