cartouche

Sphinx is een populaire tool voor het documenteren van de Python API's die reStructuredText gebruikt als zijn lichtgewicht opmaaktaal. Sphinx breidt geherstructureerd tekst met semantische markup elementen voor het documenteren van Python API's, maar wanneer deze worden gebruikt is de verhouding van markup naar inhoud te hoog wordt en de leesbaarheid is genoeg aangetast dat de docstring ongeschikt voor gebruik met standaard Python introspectie mechanismen als hulp () of IDE's.
. cartouche is een een Sphinx extensie die automatisch converteert een zeer leesbare docstring & nbsp; formaat dat geschikt is voor gebruik met hulp () en IDE naar de reStructuredText hiërogliefen vereist door Sphinx

Eisen :

• Python
• Sphinx