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

Class WarningStreamHandler

Module logging

Classes

ColorizeFormatter
DisableWarningIsErrorFilter
InfoFilter
InfoLogRecordTranslator
LastMessagesWriter
LogCollector
MemoryHandler
MessagePrefixFilter
NewLineStreamHandler
OnceFilter
SafeEncodingWriter
SphinxInfoLogRecord
SphinxLoggerAdapter
SphinxLogRecord
SphinxLogRecordTranslator
SphinxWarningLogRecord
WarningIsErrorFilter
WarningLogRecordTranslator
WarningStreamHandler
WarningSuppressor

Functions

convert_serializable
get_node_location
getLogger
is_suppressed_warning
pending_logging
pending_warnings
prefixed_warnings
setup
skip_warningiserror
suppress_logging

Variables

COLOR_MAP
LEVEL_NAMES
NAMESPACE
VERBOSE
VERBOSITY_MAP

`sphinx.util.logging.WarningStreamHandler`

class documentation

class WarningStreamHandler(logging.StreamHandler): (source)

View In Hierarchy

StreamHandler for warnings.

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