Whooshdoc. Indice Docstrings per la ricerca a full-text
Scarica ora

Whooshdoc. Classifica e riepilogo

Whooshdoc. Tag

Libreria Python. Pitone Ricerca full-text testo intero Stringhe di documenti Python Docstrings.

Whooshdoc. Descrizione

Indice Docstrings per la ricerca full-text Whooshdoc è una libreria di ricerca indicizzata a pieno testo per Docstrings Python. Usa chiosh per fare l'indicizzazione e la ricerca, quindi il nome. Include strumenti per la raccolta di DocStrings per indicizzarli e per la ricerca dell'indice.PrereQualizzati per cercare un indice preparato, tutto ciò di cui hai bisogno è CHEOSH. Whooshdoc utilizza Epydoc per attraversare pacchetti e raccogliere i loro docstrings per costruire un indice di ricerca. Tuttavia, Epydoc non è richiesto; È possibile aggiungere a un indice whooshdoc utilizzando l'API Whoosh (vedere Whooshdoc / Util.py per lo schema), senza utilizzare Epydoc.Questo pacchetto utilizza SetupTools per l'installazione e per localizzare un indice WHOSHDOC predefinito. Whooshdoc utilizza ARGARSE per la riga di comando argomenti.installationyou può installare whooshdoc, insieme alle sue dipendenze, utilizzando con setuptools 'easy_install: $ easy_install whooshdocor tramite il normale meccanismo di setup.py dopo il download e il disimballaggio del tarball: $ cd whooshdoc-1.0 $ Python Setup. Py Installto Utilizzare la GUI di ricerca wxpython, è necessario installare i tratti di cittá e i pacchetti TRAITSBackendWX. Per fare ciò, utilizzare il seguente comando Easy_Install: $ Easy_Install 'Whooshdoc ' La sorgente di sviluppo può essere verificata tramite Subversion: $ svn co https://svn.thenthought.com/svn/svn./whooshdoc/trunk arriva con uno script, wdoc. Ha diversi sottomardi. Utilizzare "wdoc --help" e "wdoc --help" per vedere Guida dettagliata. Per indicizzare un pacchetto utilizzando EpyDoc per raccogliere DocStrings, utilizzare "Indice WDOC". Ad esempio: $ wdoc indice NumpyPer utilizzare l'utilità di ricerca della console, utilizzare "Search wdoc". Ad esempio: $ WDOC Search --Help # per una spiegazione della sintassi della query. $ Wdoc Search Besel o Airy non filtra $ wdoc cerca '"Ricerche di frase Hai bisogno di strano quotando"' # perché i gusci interpretano anche i caratteri di citazione. GUI, usa "wdoc ui". Ad esempio: $ wdoc ui $ wdoc ui bessel o ariy non filtra per specificare esplicitamente la directory dell'indice whooshdoc, utilizzare l'opzione -i /-index prima di uno qualsiasi di questi sottomarini. Ad esempio: $ wdoc --index ~ / biblioteca / whooshdoc cerca besselto rimuovere determinati docstrings (ad esempio, poiché hai aggiornato un pacchetto e vuoi reindererlo), utilizzare "delgroups wdoc". Ad esempio: # prima, indice un paio di pacchetti Scipy con il nome del gruppo "Scipy" $ wdoc indice --group scipy scipy.linalg scipy.optimize # ora cancellali. $ Wdoc delgroups scipiepyipythonwhooshdoc include un comando "magico" di Ippython Whoosh, che esegue una query whooshdoc e presenta i risultati nella console, come il comando "wdoc search". Il comando% whoosh integra con i meccanismi di aiuto di Ippython per visualizzare l'aiuto per i singoli elementi. Per abilitarlo, aggiungi il seguente al tuo file IPY_USER_CONF.PY: da Whooshdoc.ipython Import Enableable ('/ percorso / to / whooshdoc / index') Ora puoi cercare usando% whoosh in Ippython. Ad esempio: in :% whoosh bessel o requisiti ariosi non filtranti: · Python.

Whooshdoc. Software correlato