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.
1 maintainer
Metadata
1 maintainer
Release files for cartouche 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cartouche-1.1.2.tar.gz | 161.5 kB | Details |
Release files / cartouche-1.1.2.tar.gz
| Download URL | cartouche-1.1.2.tar.gz |
|---|---|
| Size | 161.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e264371dbe896d96361ee501ccfcebc6dfc5d5c3f7dfbda05a3f7a3c2214a426
|
|
BLAKE2b-256 checksum How to use checksums |
35a6fc065f646c618af611b1e4deb461807443640ca99bed89d68c1748f59dd7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
