Python kommt zusammen mit pydoc. Sie können pydoc verwenden , um die Dokumentation für Ihr Modul oder Paket automatisch zu generieren. Dazu muss Ihr Modul oder Paket Docstrings enthalten.
Sie können pydoc direkt vom Terminal ausführen. cd in das Verzeichnis, das das Modul enthält, für das Sie automatisch eine Dokumentation generieren möchten. Führen Sie dann den folgenden Befehl aus.
python -m pydoc -w modulenameIn diesem Fall ist das Modul modulename.py. Der obige Befehl generiert eine HTML-Datei, die die automatisch generierte Dokumentation enthält.
Für ein größeres Projekt ziehe ich es vor, alle Dokumentationen für alle Module in einem Verzeichnis zu speichern. Dazu erstelle ich zunächst die Dokumentation für jedes Modul. Ich mache das mit obigem Befehl.
Als nächstes erstelle ich mit dem folgenden Befehl ein leeres Verzeichnis
mkdir docsIn diesem Fall heißt das neue Verzeichnis „docs“.
Zuletzt verschiebe ich alle automatisch generierten .html-Dateien in das Verzeichnis docs .
mv *.html docs