API de ambiente de construção¶

class sphinx.environment.BuildEnvironment[código-fonte]¶

Atributos

app¶: Refer. ao objeto (aplicação) Sphinx.

config¶: Referência ao objeto Config.

project¶: Projeto alvo. Veja Project.

srcdir¶: Diretório Fonte.

doctreedir¶: Diretório para armazenar doctrees serializados com pickle.

events¶: Um objeto EventManager.

found_docs¶: Um conjunto de todos os docnames existentes.

metadata¶: Dicionário mapeando docnames para “metadados” (veja Metadados de todo o arquivo).

titles¶: Dicionário mapeando docname para o nó docutils para seu título principal.

docname¶: Retorna o docname do documento que está sendo analisado no momento.

parser¶: Retorna o analisador usado para analisar o documento atual.

Atributos pré-documentos

current_document¶

Armazenamento temporário de dados durante a leitura de um documento.

As extensões podem usar a interface de mapeamento fornecida por env.current_document para armazenar dados relacionados ao documento atual, mas devem usar um prefixo exclusivo para evitar conflitos de nomes.

Importante

Somente os seguintes atributos constituem a API pública. O tipo em si e quaisquer métodos ou outros atributos permanecem privados, experimentais e serão alterados ou removidos sem aviso.

current_document.docname: str¶: O nome do documento (‘docname’) para o documento atual.

current_document.default_role: str¶: O papel padrão para o documento atual. Definido pela diretiva default-role.

current_document.default_domain: Domain | None¶: O domínio padrão para o documento atual. Definido pela diretiva default-domain.

current_document.highlight_language: str¶: A linguagem padrão para realce de sintaxe. Definido pela diretiva highlight para substituir o valor de configuração highlight_language.

current_document._parser: Parser | None¶

Este atributo é experimental e pode ser alterado sem aviso prévio.

O analisador sendo usado para analisar o documento atual.

Métodos utilitários

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

Retorna o nome do arquivo para o nome do documento.

Se base for True, retorna o caminho absoluto em self.srcdir. Se base for False, retorna o caminho relativo para self.srcdir.

relfn2path(filename: str | Path, docname: str | None = None) → tuple[str, str][código-fonte]¶

Retorna caminhos para um arquivo referenciado em um documento, relativo à raiz e absoluto da documentação.

Na entrada “filename”, os nomes de arquivos absolutos são considerados relativos ao diretório fonte, enquanto os nomes de arquivos relativos são relativos ao diretório do documento que o contém.

note_dependency(filename: str | PathLike[str], *, docname: str | None = None) → None[código-fonte]¶

Adiciona filename como uma dependência do documento atual.

Isso significa que o documento será reconstruído se este arquivo for alterado.

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

new_serialno(category: str = '') → int[código-fonte]¶

Retorna um número de série, por ex. para alvos de entrada de índice.

É garantido que o número seja exclusivo no documento atual.

note_reread() → None[código-fonte]¶: Adiciona o documento atual à lista de documentos que serão relidos automaticamente na próxima construção.