Whooshdoc. Index-DocStrings für die Volltextsuche
Jetzt downloaden

Whooshdoc. Ranking & Zusammenfassung

Whooshdoc. Stichworte

Python-Bibliothek Python Volltextsuche voller Text Python-Dokumentzeichenfolgen Docstrings

Whooshdoc. Beschreibung

Index-DocStrings für die Volltextsuche Whooshdoc ist eine indizierte, full-text-Suchbibliothek für Python-DocStrings. Es verwendet Whoosh, um die Indexierung und Suche, somit der Name. Es enthält Tools zum Sammeln von DocStrings, um sie zu indexieren und den Index zu durchsuchen. WhooshDoc verwendet EPYDOC, um Pakete zu durchqueren und ihre DocStrings zu sammeln, um einen Suchindex zu erstellen. EPYDOC ist jedoch nicht erforderlich; Sie können einen WhoShdoc-Index mithilfe der Whoosh-API hinzufügen (siehe WhooshDoc / Util.py für das Schema), ohne dass EPYDOC.Das Paket verwendet wird, verwendet SetUtuptools für die Installation und zum Suchen eines Standard-WhoShdoc-Index. WhooshDoc verwendet Argparse für die Befehlszeile. PY InfoTo Verwenden Sie die WXPYTHON-SEARK-GUI, müssen Sie die Merkmale und den TraitsbackendWX-Paketen installieren. Verwenden Sie dazu den folgenden Easy_install-Befehl: $ Easy_install 'whooshdoc ' Die Entwicklungsquelle kann über Subversion ausgecheckt werden: $ svn co https://svn.enthought.com/svn/enthalter/whooshdoc/trunk whooshdocwdocwhooshdoc mit einem Skript, wdoc. Es hat mehrere Unterbefehle. Verwenden Sie "wdoc --help" und "wdoc --help", um detaillierte Hilfe zu sehen. Um ein Paket mit EPYDOC zu integrieren, um DocStrings zu sammeln, verwenden Sie "WDOC Index". Beispiel: $ WDOC Index NUMPY, um das Arzneimittel des Konsolens zu verwenden, verwenden Sie "WDOC SEARCH". Zum Beispiel: $ wdoc search --help # für eine Erläuterung der Abfrage-Syntax. $ WDOC-Suche Bessel oder luftiger nicht filtern $ WDOC-Suche '"Phrasensuche benötigen seltsame Zitat"' #, da Shells auch Zitatfiguren interpretiert. GUI, verwenden Sie "WDOC UI". Beispiel: $ wdoc ui $ wdoc ui Bessel oder luftiger, nicht Filter, um explizit das Verzeichnis weoShdoc Index ausdrücklich anzugeben, verwenden Sie die Option -I / - Index, bevor Sie eine dieser Unterbefehle verwenden. Zum Beispiel: $ WDOC -Index ~ / Bibliothek / WhooshDoc-Suche Besselto Entfernen Sie bestimmte DocStrings (z. B., weil Sie ein Paket aktualisiert haben und REINDEX IT) verwenden, "WDOC Delgroups" verwenden. ZB Whoosh, der eine WhooshDoc-Abfrage durchführt und die Ergebnisse in der Konsole präsentiert, wie der Befehl "WDOC SEARCH". Der% WhoSh-Befehl integriert die Hilfemechanisen von IPYTHON, um die Hilfe für die einzelnen Elemente anzuzeigen. Fügen Sie Ihrem ipy_user_conf.py-Datei Folgendes hinzu: von whooshdoc.ipython import äquidenable ('/ path / to to / whooshdoc / index') Jetzt können Sie mit% WeoSh in IPYTHON suchen. Zum Beispiel: In :% Whoosh Bessel oder luftiger Filteranforderungen: · Python

Whooshdoc. Zugehörige Software