Crate parserst

Crate parserst 

Source
Expand description

Recursive descent reStructuredText parser that targets a lightweight AST.

The crate exposes helpers to parse raw docstrings into Block nodes via parse, and render them as HTML with html_of.

When the markdown feature is enabled, you can also normalize docstrings into Markdown using [markdown_of].

The internal parser is intentionally small and resilient enough to handle the eclectic docstring styles used in the Python ecosystem.

Re-exports§

pub use error::ParseError;

Modules§

error

Structs§

Field
A single field within a field list.

Enums§

Block
Block-level nodes in the parsed document tree.
Inline
Inline-level nodes produced by the parser.
ListKind
List flavor used by Block::List.

Functions§

html_of
Render the provided docstring to HTML by parsing it and concatenating the HTML representation of each Block.
parse
Parse raw reStructuredText-like input into a vector of Block nodes.