überschreiben .rst Dateien während der Sphinx Dokumentation

Question

Lassen Sie uns sagen, dass wir eine Dokumentenstruktur haben, die wie die

. 
|____src 
| |____abc.py 
|____docs 

Nun folgt aussieht wir erzeugen Dokumentation mit dem Befehl:

sphinx-apidoc -F -o docs src 

Dies erzeugt mehrere Dateien innerhalb der ./docs/ Ordner, einschließlich eine ./docs/abc.rst, die ich jetzt mit einer make html innerhalb der ./docs/ Ordner erstellen kann.

Nun, nachdem ich einige zusätzliche Funktion innerhalb ./src/abc.py hinzufügen möchte ich die Dokumentation neu erstellen. Ich versuche die gleichen Dinge und Sphinx sagt, dass die Restdatei bereits vorhanden ist und daher keine Updates erhält. Ich muss die relevanten Dateien manuell löschen, bevor ich die Dokumentation aktualisieren kann.

Nun ist die Frage, wie mache ich den gesamten Prozess, ohne auf die .rst Dateien löschen zu müssen.

Answer 1

sphinx-apidoc verfügt über eine --force Option zum Überschreiben von Dateien.

Siehe http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html#sphinx-apidoc-manual-page.