cartouche

Sphinx ist ein beliebtes Werkzeug für die Dokumentation von Python-APIs, die reStructuredText als seine leichte Markup-Sprache verwendet. Sphinx verläuft für die Dokumentation von Python-APIs neu strukturiert Text mit semantisches Markup-Elemente, aber, wenn diese zum Inhalt verwendet das Verhältnis von Markup zu hoch wird und Lesbarkeit ist genug beeinträchtigt, dass die Docstring für den Einsatz mit Standard-Python-Mechanismen wie Selbstbeobachtung Hilfe () oder IDEs ungeeignet wird.
. Kartusche ist eine eine Sphinx-Erweiterung, die automatisch konvertiert eine gut lesbare Docstring & nbsp;-Format für den Einsatz mit Hilfe () und IDEs den reStructuredText Hieroglyphen von Sphinx erforderlich

Anforderungen

• Python
• Sphinx