Metadata-Version: 2.4
Name: cartouche
Version: 1.1.2
Summary: Sphinx "cartouche" extension
Home-page: https://github.com/rob-smallshire/cartouche
Download-URL: https://pypi.python.org/pypi/cartouche
Author: Robert Smallshire
Author-email: robert@smallshire.org.uk
License: BSD
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires: sphinx
Requires-Dist: Sphinx>=0.6
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: platform
Dynamic: requires
Dynamic: requires-dist
Dynamic: summary

Sphinx is a popular tool for documenting Python APIs which uses reStructuredText
as a its lightweight markup language. Sphinx extends restructured text with
semantic markup elements for documenting Python APIs but when these are used the
ratio of markup to content becomes too high and readability is compromised
enough that the docstring becomes unsuitable for use with standard Python
introspection mechanisms like help() or IDEs.

Cartouche is an a Sphinx extension which automatically converts a highly
readable docstring format suitable for use with help() and IDEs to the
reStructuredText hieroglyphics required by Sphinx.

