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

Exception InvalidMaxAge

Module sphinx

Classes

CacheT
IntersphinxCache
SphinxInventory
SphinxInventoryWriter
InvalidMaxAge
_Unit

Functions

parseMaxAge
prepareCache
_parseInventoryLine

Variables

MAX_AGE_DEFAULT
MAX_AGE_HELP
USER_INTERSPHINX_CACHE
logger
_maxAgeUnitNames
_maxAgeUnits

`pydoctor.sphinx.InvalidMaxAge`

exception documentation

class InvalidMaxAge(Exception): (source)

View In Hierarchy

Raised when a string cannot be parsed as a maximum age.

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