Projekt-API¶

class sphinx.project.Project(srcdir: str | os.PathLike[str], source_suffix: Iterable[str])[Quelle]¶

Ein Projekt ist die Quellcode-Sammlung der Sphinx-Dokumente.

discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) → set[str][Quelle]¶: Findet alle Dokumentendateien im Quellverzeichnis und legt sie in docnames ab.

doc2path(docname: str, absolute: bool) → _StrPath[Quelle]¶

Gibt den Dateinamen für den Dokumentennamen zurück.

Wenn absolute True ist, wird ein absoluter Pfad zurückgegeben. Andernfalls wird ein relativer Pfad zum Quellverzeichnis zurückgegeben.

path2doc(filename: str | PathLike[str]) → str | None[Quelle]¶

Gibt den Dokumentennamen für den Dateinamen zurück, wenn die Datei ein Dokument ist.

filename sollte absolut oder relativ zum Quellverzeichnis sein.

restore(other: Project) → None[Quelle]¶: Übernimmt ein Ergebnis des letzten Builds.

docnames: set[str]¶: Die Namen der Dokumente, die zu diesem Projekt gehören.