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

Class obj_reference

Module docutils

Classes

obj_reference
wbr

Functions

build_table_of_content
get_lineno
new_document
set_node_attributes
_set_nodes_parent

Variables

_DEFAULT_DOCUTILS_SETTINGS

`pydoctor.epydoc.docutils.obj_reference`

class documentation

class obj_reference(nodes.title_reference): (source)

View In Hierarchy

A reference to a documentable object.

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