einschließlich dynamischen Inhalt in Dokumentation von Python-Sphinx generiert

Question

Ich benutze Sphinx, um Dokumentation für mein Projekt zu generieren, und erstellen Sie die Dokumentation als Teil der Installation des Produkts. Ich möchte den Hostnamen dynamisch in den Text und/oder Code-Blöcke aufnehmen. Ich habe keine Erklärungen in der Dokumentation irgendwelche Einrichtungen für die Aufnahme der Ausgabe eines Shell-Befehls oder etwas anderes als bestimmte Zeile (n) aus einer bestimmten Datei gesehen. Gibt es diese Kapazität?

Answer 1

Hier sind zwei Sphinx extensions die dies tun können:

• autorun: führt Python-Code in runblock Richtlinien, fängt die Ausgabe und fügt sie in Dokumente.
• programoutput: führt beliebige Befehle mit der Anweisung program-output aus und fügt die Ausgabe in Dokumente ein.