Versions

Description

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.

Repository

https://github.com/rob-smallshire/cartouche.git

Project Slug

cartouche

Last Built

6 years, 8 months ago passed

Maintainers

Home Page

https://github.com/rob-smallshire/cartouche

Badge

Tags

documentation, sphinx

Short URLs

cartouche.readthedocs.io
cartouche.rtfd.io

Default Version

latest

'latest' Version

master