Home > sphinx-6.1.3

sphinx API Documentation Modules Classes Names

search in docstrings

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

Exception ElementLookupError

Module docutils

Classes

CustomReSTDispatcher
LoggingReporter
NullReporter
ReferenceRole
sphinx_domains
SphinxDirective
SphinxFileOutput
SphinxRole
SphinxTranslator
WarningStream
ElementLookupError

Functions

docutils_namespace
du19_footnotes
is_directive_registered
is_html5_writer_available
is_node_registered
is_role_registered
new_document
patch_docutils
patched_get_language
patched_rst_get_language
register_directive
register_node
register_role
switch_source_input
unregister_node
unregister_role
using_user_docutils_conf

Variables

__document_cache__
additional_nodes
logger
report_re

`sphinx.util.docutils.ElementLookupError`

exception documentation

class ElementLookupError(Exception): (source)

View In Hierarchy

Undocumented

API Documentation for sphinx, generated by pydoctor 22.9.1 at 2023-01-11 01:04:09.