Whooshdoc INDEX DOCKRINGS VOOR FULL-TEXT ZOEKEN
Download nu

Whooshdoc Rangschikking & Samenvatting

Whooshdoc Tags

Python-bibliotheek Python Zoek volledige text hele tekst Python-docstrings docstrings

Whooshdoc Beschrijving

Index Docstrings voor Full-Text Search WHOOSHDOC is een indexed, full-text Search-bibliotheek voor Python Docstrings. Het gebruikt whosh om het indexeren en zoeken te doen, vandaar de naam. Het bevat hulpmiddelen voor het verzamelen van docstrings om ze te indexeren en voor het zoeken van de index.Prerequisites voor het zoeken naar een voorbereide index, is alles wat u nodig hebt whosh. WhooShdoc gebruikt Epydoc om pakketten te doorkruisen en hun docstrings te verzamelen om een zoekindex te bouwen. Epydoc is echter niet vereist; U kunt toevoegen aan een WHOOSHDOC-index met behulp van de WHOSHDAPI (zie whoShdoc / util.py voor het schema), zonder EPYDOC te gebruiken. Dit pakket maakt gebruik van SetUptools voor installatie en voor het lokaliseren van een standaard Whoshdoc-index. WHOOSHDOC gebruikt Argparse voor opdrachtregelargumenten. Installatie kan Whooshdoc, samen met zijn afhankelijkheden, met behulp van de Easy_Install van Setuptools via het normale setup.py-mechanisme na het downloaden en uitpakken en uitpakken van de TARBALL: $ CD WHOOSHDOC-1,0 $ Python Setup. PY Installeer om de WXPYTHON Search GUI te gebruiken, u moet de eigenschappen van Enthoughts and Traitsbackendwx installeren. Om dit te doen, gebruikt u de volgende easy_install-opdracht: $ Easy_Install 'WHOOSHDOC ' De ontwikkelingsbron kan worden uitgecheckt via Subversion: $ SVN CO https://svn.pts.com/svn/thought/whoomhdoc/trunk Whooshdocwdocwhoosdoc komt met één script, WDOC. Het heeft verschillende subopdrachten. Gebruik "WDOC --HELP" en "WDOC --HELP" om gedetailleerde help te zien. Om een pakket te indexeren met EPYDOC om docstrings te verzamelen, gebruik "WDOC-index". Bijvoorbeeld: $ WDOC-index Numpy To Gebruik het Hulpprogramma Console Zoeken, "WDOC Search" gebruiken. Bijvoorbeeld: $ WDOC Zoeken --Help # voor een uitleg van de query-syntaxis. $ WDOC Search Bessel of Airy Not Filter $ WDOC Search '"Phrase-zoekopdrachten hebben raar citeren' # omdat schelpen ook citaat tekens interpreteren. Om de WXPYTHON te interpreteren GUI, gebruik "WDOC UI". Bijvoorbeeld: $ WDOC UI $ WDOC UI BESSEL OF AIRY NIET FILTERTOE PLAATSELIJK DE WHOOSHDOC Index Directory, gebruik de optie -I / - index vóór een van deze subopdrachten. Bijvoorbeeld: $ WDOC --Index ~ / Library / WhoOShdoc Search Besselto Verwijder bepaalde DocStrings (bijvoorbeeld omdat u een pakket hebt bijgewerkt en wilt REINDXEN), gebruik "WDOC Delgroups". Bijvoorbeeld: # Eerste, index een paar Scipy-pakketten met de groepsnaam "Scipy" $ WDOC-index - Groep Scipy Scipy.Linalg Scipy.Optimize # Verwijder ze nu. $ WDOC Delgroups SCIPYIPYTHONWHOSHDOC omvat een IPYTHON "Magic" -opdracht,% Whoosh, die een WhoOShdoc-query uitvoert en de resultaten in de console presenteert, zoals de opdracht "WDOC SEARCH". Het% WhoSh-commando integreert met de hulpmechanismen van IPYTHON om de hulp voor de afzonderlijke items weer te geven. Om het in te schakelen, voegt u het volgende toe aan uw IPY_USER_CONF.PY-bestand: van WHOOSHDOC.IPYTHON IMPORT APPORTBAREBARE ('/ PACE / TO / TO / WHOOSHDOC / INDEX') Nu kunt u zoeken met% whoosh in IPYTHON. Bijvoorbeeld: in :% Whoosh Bessel of Airy Not Filter-vereisten: · Python

Whooshdoc Gerelateerde software