pydoctor 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

Module table

Classes

ChildTable
TableRow

Package pages

Modules

attributechild
functionchild
sidebar
table

Classes

ClassPage
CommonPage
Head
ModulePage
Nav
PackagePage
Page
ZopeInterfaceClassPage

Functions

assembleList
format_class_signature
format_decorators
format_function_def
format_overloads
format_signature
get_override_info

Variables

commonpages

`pydoctor.templatewriter.pages.table`

module documentation

(source)

Undocumented

Class	`ChildTable`	Undocumented
Class	`TableRow`	Undocumented

API Documentation for pydoctor, generated by pydoctor 23.9.0.dev0 at 2024-04-22 13:33:07.