pydocstring 0.3.0

A zero-dependency Rust parser for Python docstrings (Google and NumPy styles) with a unified syntax tree and byte-precise source locations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! NumPy-style docstring support.
//!
//! This module contains the AST types and parser for NumPy-style docstrings.

pub mod kind;
pub mod nodes;
pub mod parser;
pub mod to_model;

pub use crate::parse::text_block::TextBlock;
pub use crate::parse::visitor::DocstringVisitor;
pub use crate::parse::visitor::walk;
pub use kind::NumPySectionKind;
pub use nodes::NumPyAttribute;
pub use nodes::NumPyDeprecation;
pub use nodes::NumPyDocstring;
pub use nodes::NumPyException;
pub use nodes::NumPyMethod;
pub use nodes::NumPyParameter;
pub use nodes::NumPyReference;
pub use nodes::NumPyReturns;
pub use nodes::NumPySection;
pub use nodes::NumPySectionHeader;
pub use nodes::NumPySeeAlsoItem;
pub use nodes::NumPyWarning;
pub use nodes::NumPyYields;
pub use parser::parse_numpy;