Home > mistletoe-1.0.1

mistletoe 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 __main__

Functions

main

Package mistletoe

Modules

contrib
ast_renderer
base_renderer
block_token
block_tokenizer
cli
core_tokens
html_renderer
latex_renderer
latex_token
span_token
span_tokenizer
token
utils
__main__

Functions

markdown

Variables

__version__

`mistletoe.main`

module documentation

(source)

Make mistletoe runnable as a script with default settings.

Function main Entry point.

def main(): (source) ¶

Entry point.

API Documentation for mistletoe, generated by pydoctor 22.9.1.dev0 at 2023-02-04 21:54:04.