Automatische Generierung von Python-Dokumentation mithilfe von Sphinx bei Verwendung dynamischer Klassen und dynamischer Module

Question

Ich habe derzeit einen Anwendungsfall, in dem ich Python-Klassen in Modulen mit dem folgenden Code erstellen.

... 
module = type.ModuleType(module_name) 
... 
klass = type(name, (object,), dict(__doc__='docstring')) 
... 
setattr(module, name, klass) 
... 

Sphinx kann jedoch keine Dokumentation für diese Klassen generieren. Es ist nicht einmal in der Lage, die Klassen zu finden. Gibt es eine Möglichkeit, Sphinx eine Erweiterung hinzuzufügen, um diesen Anwendungsfall zu behandeln? Gedanken?

Das vollständige minimale Arbeitsbeispiel hierfür befindet sich here.

Answer 1

Sie haben die folgende automodule Richtlinie in modules.rst:

.. automodule:: modules 
    :members: 
    :undoc-members: 
    :show-inheritance: 

Aber die qualifizierten Namen der dynamischen Module sind modules.Module1 und modules.Module2 (diese Namen sind sys.modules in _factory.py hinzugefügt).

Die folgenden Werke für mich:

.. automodule:: modules.Module1 
    :members: 
    :undoc-members: 
    :show-inheritance: 

.. automodule:: modules.Module2 
    :members: 
    :undoc-members: 
    :show-inheritance: