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 autosummary_toc

Package autosummary

Modules

generate

Classes

AutoLink
Autosummary
autosummary_table
autosummary_toc
FakeApplication
FakeDirective
ImportExceptionGroup

Functions

autosummary_noop
autosummary_table_visit_html
autosummary_toc_visit_html
extract_summary
get_documenter
get_import_prefixes_from_env
get_rst_suffix
import_by_name
import_ivar_by_name
limited_join
mangle_signature
process_generate_options
setup
strip_arg_typehint
_cleanup_signature
_import_by_name

Variables

WELL_KNOWN_ABBREVIATIONS
literal_re
logger
periods_re

`sphinx.ext.autosummary.autosummary_toc`

class documentation

class autosummary_toc(nodes.comment): (source)

View In Hierarchy

Undocumented

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