API de projeto¶

class sphinx.project.Project(srcdir: str | os.PathLike[str], source_suffix: Iterable[str])[código-fonte]¶

Um projeto é o conjunto de código-fonte do(s) documento(s) Sphinx.

discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) → set[str][código-fonte]¶: Encontra todos os arquivos de documentos no diretório fonte e coloca-os em docnames.

doc2path(docname: str, absolute: bool) → _StrPath[código-fonte]¶

Retorna o nome do arquivo para o nome do documento.

Se absolute for True, retorna como um caminho absoluto. Caso contrário, retorne como um caminho relativo para o diretório fonte.

Retorna o docname para o nome do arquivo se o arquivo for um documento.

filename deve ser absoluto ou relativo ao diretório fonte.

restore(other: Project) → None[código-fonte]¶: Assume o resultado da última construção.