I'm trying to generate docs (with mkdocstrings + Griffe) for some Rust structs like the one below:
/// Some Object O
#[gen_stub_pyclass]
#[pyclass(get_all)]
struct O {
/// Some value
value: u32,
}
#[gen_stub_pymethods]
#[pymethods]
impl O {
/// Extra value
#[getter]
pub fn extra(&self) -> u32 {0}
}
This generates something like:
class O:
r'''
Some Object O
'''
value: int
extra: int
It would be helpful if we collect the documentation from fields/getter methods and aggregate them into one single docstring:
r'''
Some Object O
Attributes:
value: Some value
extra: Extra value
'''
I'm not sure if this feature would be out of scope of this crate or not, if so, please free feel to close this issue.
Hi,
I'm trying to generate docs (with
mkdocstrings
+Griffe
) for some Rust structs like the one below:This generates something like:
It would be helpful if we collect the documentation from fields/getter methods and aggregate them into one single docstring:
I'm not sure if this feature would be out of scope of this crate or not, if so, please free feel to close this issue.