Commits

Matt Chaput  committed 2430e18

* Added import of query.spans.* in query package.
* Updated API documentation to match Whoosh 2.5.
* Removed outdated dawg module docs for now.
* Fixed underline problem in searching.rst.
* Silenced warning about static html path by commenting lline in conf.py.

  • Participants
  • Parent commits b574c74

Comments (0)

Files changed (15)

File docs/source/api/codec/base.rst

 .. autoclass:: FieldWriter
    :members:
 
+.. autoclass:: PostingsWriter
+   :members:
+
 .. autoclass:: TermsReader
    :members:
 
-.. autoclass:: VectorReader
-   :members:
-
-.. autoclass:: LengthsReader
-   :members:
-
-.. autoclass:: MultiLengths
-   
-.. autoclass:: StoredFieldsReader
+.. autoclass:: PerDocumentReader
    :members:
 
 .. autoclass:: Segment
    :members:
 
 
-
-

File docs/source/api/filedb/filestore.rst

+===========================
+``filedb.filestore`` module
+===========================
+
+.. automodule:: whoosh.filedb.filestore
+
+Base class
+==========
+
+.. autoclass:: Storage
+    :members:
+
+
+Implementation classes
+======================
+
+.. autoclass:: FileStorage
+.. autoclass:: RamStorage
+
+
+Helper functions
+================
+
+.. autofunction:: copy_storage
+.. autofunction:: copy_to_ram
+
+
+Exceptions
+==========
+
+.. autoexception:: ReadOnlyError

File docs/source/api/filedb/filetables.rst

+============================
+``filedb.filetables`` module
+============================
+
+.. automodule:: whoosh.filedb.filetables
+
+
+Hash file
+=========
+
+.. autoclass:: HashWriter
+    :members:
+
+.. autoclass:: HashReader
+    :members:
+
+
+Ordered Hash file
+=================
+
+.. autoclass:: OrderedHashWriter
+.. autoclass:: OrderedHashReader

File docs/source/api/filedb/structfile.rst

+============================
+``filedb.structfile`` module
+============================
+
+.. automodule:: whoosh.filedb.structfile
+
+Classes
+=======
+
+.. autoclass:: StructFile
+    :members:
+
+.. autoclass:: BufferFile
+.. autoclass:: ChecksumFile

File docs/source/api/idsets.rst

+============================
+``support.bitvector`` module
+============================
+
+.. automodule:: whoosh.idsets
+
+
+Base classes
+============
+
+.. autoclass:: DocIdSet
+    :members:
+
+.. autoclass:: BaseBitSet
+
+
+Implementation classes
+======================
+
+.. autoclass:: BitSet
+.. autoclass:: OnDiskBitSet
+.. autoclass:: SortedIntSet
+.. autoclass:: MultiIdSet

File docs/source/api/index.rst

 .. autofunction:: version
 
 
-Index class
-===========
+Base class
+==========
 
 .. autoclass:: Index
     :members:
 
 
+Implementation
+==============
+
+.. autoclass:: FileIndex
+
+
 Exceptions
 ==========
 
-.. autoexception:: EmptyIndexError
+.. autoexception:: LockError
+.. autoexception:: IndexError
 .. autoexception:: IndexVersionError
 .. autoexception:: OutOfDateError
-.. autoexception:: IndexError
+.. autoexception:: EmptyIndexError

File docs/source/api/query.rst

 .. autoclass:: Otherwise
 
 
+Span queries
+============
+
+.. autoclass:: Span
+    :members:
+
+.. autoclass:: SpanQuery
+.. autoclass:: SpanFirst
+.. autoclass:: SpanNear
+.. autoclass:: SpanNot
+.. autoclass:: SpanOr
+.. autoclass:: SpanContains
+.. autoclass:: SpanBefore
+.. autoclass:: SpanCondition
+
+
 Special queries
 ===============
 
 ==========
 
 .. autoexception:: QueryError
-
-

File docs/source/api/searching.rst

 ==========
 
 .. autoexception:: NoTermsException
-
 .. autoexception:: TimeLimit
 

File docs/source/api/spans.rst

-================
-``spans`` module
-================
-
-.. automodule:: whoosh.spans
-
-
-Span representation
-===================
-
-.. autoclass:: Span
-    :members:
-
-
-Span queries
-============
-
-.. autoclass:: SpanQuery
-.. autoclass:: SpanFirst
-.. autoclass:: SpanNear
-.. autoclass:: SpanNot
-.. autoclass:: SpanOr
-.. autoclass:: SpanContains
-.. autoclass:: SpanBefore
-.. autoclass:: SpanCondition
-

File docs/source/api/store.rst

-================
-``store`` module
-================
-
-.. automodule:: whoosh.store
-
-Classes
-=======
-
-.. autoclass:: Storage
-    :members:
-
-
-Exceptions
-==========
-
-.. autoexception:: LockError
-

File docs/source/api/support/bitvector.rst

-============================
-``support.bitvector`` module
-============================
-
-.. automodule:: whoosh.support.bitvector
-
-
-Base class
-==========
-
-.. autoclass:: DocIdSet
-    :members:
-
-
-Implementation classes
-======================
-
-.. autoclass:: BitSet
-.. autoclass:: SortedIntSet
-

File docs/source/api/support/dawg.rst

-=======================
-``support.dawg`` module
-=======================
-
-.. automodule:: whoosh.support.dawg
-
-
-Graph nodes
-===========
-
-.. autoclass:: Node
-    :members:
-
-.. autoclass:: UnionNode
-.. autoclass:: IntersectionNode
-
-
-Cursor interface
-================
-
-.. autoclass:: BaseCursor
-   :members:
-
-.. autoclass:: Cursor
-
-.. autoclass:: Arc
-   :members:
-
-
-IO classes
-==========
-
-.. autoclass:: GraphWriter
-   :members:
-
-.. autoclass:: BaseGraphReader
-   :members:
-
-.. autoclass:: GraphReader
-
-
-Utility functions
-=================
-
-.. autofunction:: to_labels
-.. autofunction:: within
-
-
-FST Value classes
-=================
-
-.. autoclass:: Values
-   :members:
-
-.. autoclass:: IntValues
-.. autoclass:: SequenceValues
-.. autoclass:: BytesValues
-.. autoclass:: ArrayValues
-.. autoclass:: IntListValues

File docs/source/conf.py

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

File docs/source/searching.rst

 documents.
 
 The ``Searcher`` object
-===================
+=======================
 
 To get a :class:`whoosh.searching.Searcher` object, call ``searcher()`` on your
 ``Index`` object::

File src/whoosh/query/__init__.py

 from whoosh.query.wrappers import *
 from whoosh.query.nested import *
 from whoosh.query.qcolumns import *
+from whoosh.query.spans import *