search-engine API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module Index

  • modules - Undocumented
    • api - Undocumented
    • auth - No module docstring; 1/1 class documented
    • author - No module docstring; 1/1 class documented
    • corpus - No module docstring; 1/1 class documented
    • document - No module docstring; 3/3 classes documented
    • factory - No module docstring; 1/1 class documented
    • singleton - No module docstring; 1/1 class documented
  • utils - Undocumented
    • func_processing - No module docstring; 2/2 functions documented
    • func_retrieval - No module docstring; 2/2 functions documented
    • tools - No module docstring; 5/5 functions documented
API Documentation for search-engine, generated by pydoctor 23.9.1 at 2024-01-11 01:25:17.