Skip to main content

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 files for tiddlywebplugins.docs 0.5

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

Source distribution (sdist)

Source distribution for tiddlywebplugins.docs 0.5
File Size Uploaded
tiddlywebplugins.docs-0.5.tar.gz 7.1 kB Details

Release files / tiddlywebplugins.docs-0.5.tar.gz

Download URL tiddlywebplugins.docs-0.5.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d7efd2797a69165fb3fef86dd8ce4348b26afbd87506cee8ba705d789be6ae82
BLAKE2b-256 checksum
How to use checksums
ed778eca93f54ecec887cc32a1a0c9d26aa78ebe7f5475221b70da3682d7d6e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.5 This release

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page