Wir haben eine Sphinx-Konfiguration, die eine Menge HTML-Dokumente für unsere gesamte Codebasis generiert. Manchmal arbeite ich an einer Datei und möchte nur die HTML-Ausgabe aus dieser Datei sehen, um sicherzustellen, dass ich die Syntax richtig verstanden habe, ohne die gesamte Suite auszuführen.
Ich suchte nach dem einfachsten Befehl, den ich in einem Terminal ausführen konnte, um Sphinx in dieser einen Datei auszuführen, und ich bin mir sicher, dass die Informationen da draußen sind, aber ich habe sie nicht gesehen.
Sphinx verarbeitet reST-Dateien (nicht direkt Python-Dateien). Diese Dateien können Verweise auf Python-Module enthalten (wenn Sie autodoc verwenden). Meine Erfahrung ist, dass, wenn nur ein einzelnes Python-Modul seit dem letzten vollständigen Ausgabe-Build geändert wurde, Sphinx nicht alles neu generiert; nur die reST-Datei, die dieses bestimmte Python-Modul "einzieht", wird verarbeitet. Es gibt eine Nachricht, die updating environment: 0 added, 1 changed, 0 removed sagt.
Um eine einzelne reST-Datei explizit zu verarbeiten, geben Sie sie als Argument für sphinx-build :
Dies geschieht in zwei Schritten:
Dieses Skript erledigt die Arbeit. Rufen Sie es auf, während Sie im selben Verzeichnis wie das Modul stehen und geben Sie ihm den Dateinamen des Moduls:
%Vor%Tags und Links python python-sphinx