Listas de campos

Como discutido anteriormente, listas de campos são sequências de campos marcados assim:

:fieldname: Field content

O Sphinx estende o comportamento padrão do docutils para listas de campos e adiciona algumas funcionalidades extras que são abordadas nesta seção.

Nota

Os valores das listas de campos serão analisados ​​como strings. Você não pode usar coleções do Python, como listas ou dicionários.

Metadados de todo o arquivo

Uma lista de campos próxima ao topo de um arquivo é normalmente analisada pelo docutils como docinfo e mostrada na página. No entanto, no Sphinx, uma lista de campos que precede qualquer outra marcação é movida do docinfo para o ambiente Sphinx como metadados do documento e não é exibida na saída.

Nota

Uma lista de campos que aparece após o título do documento fará parte do docinfo normalmente e será exibida na saída.

Campos especiais de metadados

O Sphinx fornece um comportamento personalizado para campos bibliográficos em comparação com os documentos.

No momento, esses campos metadados são reconhecidos:

tocdepth

A profundidade máxima para um índice deste arquivo.

:tocdepth: 2

Nota

Esses metadados afetam a profundidade do toctree local. Mas isso não afeta a profundidade do toctree global. Então isso não altera a barra lateral dos temas que utilizam o toctree global.

Adicionado na versão 0.4.

nocomments

Se definido, a aplicação web não exibirá um formulário de comentários para uma página gerada a partir desse arquivo fonte.

:nocomments:
orphan

Se definido, avisos sobre este arquivo não sendo incluído em qualquer toctree serão suprimidos:

:orphan:

Adicionado na versão 1.0.

no-search

Desabilita pesquisa de texto completo para este documento.

:no-search:

Nota

A opção :no-search: desabilita apenas a pesquisa de texto completo, o que significa que a pesquisa de objetos ainda estará disponível mesmo se :no-search: estiver definido.

Adicionado na versão 3.0.

Alterado na versão 7.3: A opção de metadados para todo o arquivo :nosearch: foi renomeada para :no-search:. O nome anterior foi mantido como um apelido, mas será descontinuado e removido em uma versão futura do Sphinx.