Classe WebSupport

class sphinxcontrib.websupport.WebSupport

Classe principal API para suporte pacote. Todas interações com o pacote suporte web devem ocorrer através dessa classe.

Classe usa os seguintes argumentos:

diretorio fonte

O diretório que contém fonte reStructuredText arquivos.

diretório construção

O diretório para construir dados e arquivos estáticos. Deve ser usado quando criar objeto WebSupport que irá ser usado para construir dados.

diretório dados

O diretório de dados para web support. Deve ser usado quando criando objeto WebSupport que irá ser usado para recuperar dados.

buscar

Pode conter uma string (e.g. ‘xapian’) referenciando adaptator intrínseco para usar uma instância de subclasse BaseSearch.

memória

Deve conter a string representando a uri do banco de dados ou instância da subclasse StorageBackend. Se não for informado, novo banco de dados sqlite será criado.

moderation_callback

Chamada para ser usada quando novo comentário adicionado não for exibido. Aceita um argumento: dicionário representando o comentário que foi adicionado.

diretório estático

Se os arquivos estáticos devem ser criados em uma localização diferente e não em '/static', isso deve ser uma string com o nome dessa localização (por exemplo, builddir + '/static_files').

Nota

Se você especificar staticdir, você normalmente desejará ajustar staticroot de acordo.

staticroot

Se os arquivos estáticos não são servidos a partir de '/static', isso deve ser uma string com o nome daquela localização (por exemplo, '/static_files').

docraiz

Se a documentação não é servida do caminho base da URL, deve ser uma string especificando path (ex.. 'docs').

Alterado na versão 1.6: Classe WebSupport foi movida para sphinxcontrib.websupport em sphinx.websupport. Por favor adicionar pacote sphinxcontrib-websupport em suas depêndencias e usar a classe do novo pacote.

Métodos