pydocspec 0.0.0 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 DocstringMixin

Package ext

Modules

default
opt

Classes

ApiObjectMixin
ApiObjectVisitorExt
AstroidInferenceTip
AstroidTransform
AstVisitorExt
ClassMixin
DecorationMixin
DocstringMixin
ExtRegistrar
FunctionMixin
HasMembersMixin
IndirectionMixin
InheritableMixin
LocationMixin
ModuleMixin
VariableMixin
_AstroidTransform

Functions

get_default_extensions
get_optional_extensions
load_extension_module
_get_mixins
_get_setup_extension_func_from_module
_get_submodules

Variables

_mixin_to_class_name

`pydocspec.ext.DocstringMixin`

class documentation

class DocstringMixin: (source)

View In Hierarchy

Undocumented

API Documentation for pydocspec 0.0.0, generated by pydoctor 22.5.0.dev0 at 2022-04-29 00:33:08.