API do coletor de ambiente¶

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

Um EnvironmentCollector é um coletor de dados específico de cada documento.

Ele reúne dados e armazena BuildEnvironment como um banco de dados. Exemplos de dados específicos seriam imagens, arquivos de download, títulos de seções, metadados, entradas de índice e árvores de índice, etc.

Nota

Esta classe essencialmente envolve um subconjunto de retorno de chamadas de eventos do Sphinx.

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None[código-fonte]¶

Remove dados especificados de um documento.

Este método é chamado de remoção do documento.

Ver também

env-purge-doc

get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) → list[str][código-fonte]¶

Retorna uma lista de nomes de documentos para reler.

Este método é chamado antes da leitura dos documentos.

Ver também

env-get-outdated

get_updated_docs(app: Sphinx, env: BuildEnvironment) → list[str][código-fonte]¶

Retorna uma lista de nomes de documentos para reler.

Este método é chamado após a leitura de todos os documentos.

Ver também

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment) → None[código-fonte]¶: Mescla dados especificados sobre nomes de documentos de um objeto BuildEnvironment diferente que vem de um subprocesso em construções paralelas.

Ver também

env-merge-info

process_doc(app: Sphinx, doctree: nodes.document) → None[código-fonte]¶

Processa um documento e coleta dados específicos dele.

Este método é chamado após a leitura do documento.

Ver também

doctree-read