Whooshdoc Docstrings de índice para búsqueda de texto completo
Descargar ahora

Whooshdoc Clasificación y resumen

Whooshdoc Etiquetas

Biblioteca de Python Pitón búsqueda de texto completo texto completo Cadenas de documentación de Python documentos de documentos

Whooshdoc Descripción

Docstrings de índice para búsqueda de texto completo WhoShdoc es una biblioteca de búsqueda de texto completo de texto completo para Python DoCstrings. Utiliza Whoosh para hacer la indexación y búsqueda, de ahí el nombre. Incluye herramientas para recopilar documentos de documentos para indexarlos y para buscar en el índice.Prequisites para buscar un índice preparado, todo lo que necesita es WhoSh. WhoShdoc usa EpyDoc para atravesar paquetes y recolectar sus documentos para construir un índice de búsqueda. Sin embargo, no se requiere epydoc; Puede agregar a un índice WhoShdoc usando la API de Whoosh (consulte Whooshdoc / UTIL.PY para el esquema), sin usar EpyDoc. Este paquete utiliza setuptOols para la instalación y para ubicar un índice predeterminado de WhoShdoc. Whooshdoc usa Argada para los argumentos de la línea de comandos. EnStalación puede instalar WhoShDoc, junto con sus dependencias, usando con SetuptOols 'Easy_Install: $ Easy_Install Whooshdocor a través del mecanismo de configuración normal después de descargar y desembalar el tarball: $ cd whooshdoc-1.0 $ Python Configuración. PY InstallTo Utilice la GUI de búsqueda WXPYPHON, debe instalar los rasgos y los paquetes RAIPSENDWX de Entro. Para hacer esto, use el siguiente comando Easy_Install: $ Easy_Install 'WhoShdoc ' La fuente de desarrollo puede verificarse a través de Subversion: $ svn co https://svn.entgugh.com/svn/enthough/whooshdoc/trunk whooshdocwdocwhooshdoc viene con un guión, WDOC. Tiene varios subpandimentos. Use "WDOC --HELP" y "WDOC --Help" para ver Ayuda detallada. Para indexar un paquete usando EPYDOC para recopilar documentos, use "Índice WDOC". Por ejemplo: $ WDOC Index Numpyto Use la utilidad de búsqueda de la consola, use "Búsqueda WDOC". Por ejemplo: $ WDOC Búsqueda --Help # para una explicación de la sintaxis de la consulta. $ WDOC BESSEL o Airy no filtrante $ WDOC Buscar '"Las búsquedas de frases necesitan la cita rara"' # Porque las conchas también interpretan los caracteres de la cita. Para usar el wxpython GUI, use "WDOC UI". Por ejemplo: $ WDOC UI $ WDOC UI Bessel o Airy, no se filtra explícitamente, especifique explícitamente el directorio del índice de WhoShdoc, use la opción -i / - índice antes de cualquiera de estos subpandimentos. Por ejemplo: $ WDOC --Index ~ / biblioteca / búsqueda de whooshdoc Besselto Elimine ciertas documentos de documentos (por ejemplo, porque actualizó un paquete y desea reindexarlo), use "WDOC Delgroups". Por ejemplo: # Primero, Índice un par de paquetes de escape con el nombre de grupo "Scipy" $ WDOC index --Group Scipy Scipy.linalg scipy.optimize # ahora elimínelos. $ WDOC Delgroups Scipyipythonwhooshdoc incluye un comando de Ipython "Magic",% Whoosh, que realiza una consulta de WhoShdoc y presenta los resultados en la consola, como el comando "WDOC Búsqueda". El% del comando WhoSh se integra con los mecanismos de ayuda de Ipython para mostrar la ayuda para los artículos individuales. Para habilitarlo, agregue lo siguiente a su archivo IPY_USER_CONF.PY: de Whooshdoc.IPYTHON Importar en forma enanas ('/ ruta / a / whooshdoc / índice') ahora, puede buscar usando% whoosh en Ipython. Por ejemplo: en :% Whoosh Bessel o Airy No se filtra los requisitos: · Python

Whooshdoc Software relacionado