Ich versuche, mit Sphinx automatisch API-Dokumente für eine große Python-Codebasis zu erstellen.

Ich habe versucht, build_modules.py und Sphinx-Apidoc zu verwenden. Mit beiden kann ich die ersten Dokumente in meinem Ausgabeverzeichnis für die Pakete und Module der obersten Ebene erfolgreich erstellen.

Wenn ich jedoch mit baue

make html

Es gibt Tausende von Fehlern dieses Typs:

<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'rstDocs/src.Example1.class1.method1'

für jede einzelne Klasse und Methode in der Codebasis. Ich glaube, ich habe mit einigem Experimentieren herausgefunden, dass die Anweisungen für automatische Zusammenfassung / automatische Klassen Token-Bäume erzeugen, die erwarten, dass es erste Dateien für jede Klasse und Methode gibt.

Abgesehen von den Warnungen scheint die Dokumentation gut zu funktionieren, aber ich möchte sie loswerden und denke, dass ich etwas falsch konfiguriert habe.

Ich habe es auch versuchtnipype / tools zu ähnlichem Effekt.

ich veränderteapigen.py undbuild_modref_templates.py für jedes dieser "fehlenden" Dokumente erste Stubs zu erstellen, gegebenenfalls mit Autoklasse / Autofunktion / Automethoden. Die Erstellung dauert jedoch ziemlich lange (10 Minuten) und stürzt schließlich aufgrund von Speicherfehlern beim letzten Erstellungsschritt ab.

Hier ist eine Beispieldatei für das erste Modul, in der alle Warnungen erstellt werden:

src Package
===========

:mod:`src` Package
------------------

.. automodule:: src.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`Example1` Module
------------------------------------

.. automodule:: src.Example1
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`Example2` Module
------------------

.. automodule:: src.Example2
    :members:
    :undoc-members:
    :show-inheritance:

Vielen Dank für Ratschläge zur Behebung dieser Warnungen! Ich möchte mich von jeder Lösung fernhalten, bei der die Dateien des Sphinx-Site-Pakets geändert werden.