Whooshdoc. índice docstrings para pesquisa de texto completo
Baixe Agora

Whooshdoc. Classificação e resumo

Whooshdoc. Tag

Biblioteca Python. Pitão Pesquisa de texto completo texto completo Documentos Python Docstrings.

Whooshdoc. Descrição

Docstruções de índice para pesquisa de texto completo Whooshdoc é uma biblioteca de pesquisa integrada e indexada para o Python Docstrings. Ele usa whoosh para fazer a indexação e pesquisa, daí o nome. Ele inclui ferramentas para coletar docastras para indexá-las e para pesquisar o index.prerequisitosPara pesquisar um índice preparado, tudo que você precisa é Whoosh. Whooshdoc usa o EPYDOC para atravessar pacotes e recolher seus docstring para construir um índice de pesquisa. No entanto, o EPYDOC não é necessário; Você pode adicionar a um índice Whooshdoc usando a API Whoosh (consulte Whooshdoc / Util.py para o esquema), sem usar o EPYDOC.Este pacote usa SetTupTools para instalação e para localizar um índice de whooshdoc padrão. Whooshdoc usa argparse para argumentos de linha de comando.InstallationYou pode instalar whooshdoc, juntamente com suas dependências, usando com setuptols 'easy_install: $ Easy_install whooshdocor através do mecanismo setup.py normal após o download e descompactando o tarball: $ cd whooshdoc-1.0 $ python setup. PY Installto Use o WXPYTHON Search GUI, você deve instalar os traços de entranhos e pacotes traços de traços. Para fazer isso, use o seguinte comando Easy_Install: $ Easy_Install 'whooshdoc ' A fonte de desenvolvimento pode ser verificada via Subversion: $ svn co https://svn.enthought.com/svn/Shithought/whooshdoc/Crunk whooshdocwdocwhooshdoc com um script, wdoc. Tem vários subcomandos. Use "wdoc --help" e "wdoc --help" para ver a ajuda detalhada. Para indexar um pacote usando o EPYDOC para coletar docastras, usar "WDOC Index". Por exemplo: $ WDOC Index numpyto Use o utilitário de pesquisa do console, use "Wdoc Search". Por exemplo: $ WDOC Busca --help # para uma explicação da sintaxe de consulta. $ WDOC Busca Bessel ou Airy não filtro $ WDOC pesquisa '"Pesquisas de frase precisam de citação estranha"' porque as conchas também interpretam os personagens de citação. Para usar o wxpython GUI, use "wdoc ui". Por exemplo: $ WDOC UI $ WDOC UI Bessel ou Airy não filtro para especificar explicitamente o diretório de índice Whooshdoc, use a opção -i / - índice antes de qualquer um desses subcomandos. Por exemplo: $ wdoc --index ~ / biblioteca / whooshdoc pesquisa Besselto remover certos docstrings (por exemplo, porque você atualizou um pacote e deseja reindexá-lo), use "wdoc delgroups". Por exemplo: # primeiro, indexar um par de pacotes de scipy com o nome do grupo "scipy" $ wdoc index --group scipy scipy.linalg scipy.optimize # agora exclui-los. $ WDOC Delgroups ScipyipythonWhooshdoc inclui um comando IPython "Magic",% Whoosh, que realiza uma consulta Whooshdoc e apresenta os resultados no console, como o comando "WDOC Search". O% Whoosh Command se integra aos mecanismos de ajuda do IPython a exibir a ajuda para os itens individuais. Para ativá-lo, adicione o seguinte para o seu arquivo IPY_USER_CONF.PY: De Whooshdoc.ipython Imbabilizável ('/ Path / Whooshdoc / Index') Agora, você pode pesquisar usando% Whoosh em Ipython. Por exemplo: em :% Whoosh Bessel ou Airy não requisitos de filtro: · Pitão

Whooshdoc. Software Relacionado