You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm working on a project using PyO3 to build a Python library in Rust. For this project I'd like to generate good reference documentation directly from the docstrings embedded in the Rust code. As such, I set up reST code like this:
.. autoclass:: ClientConfig
:members:
This gets me nicely documented methods for the type, but it seems that a docstring attached to a type itself (which does show up when using help(ClientConfig) in the REPL) does not make it into the generated docs. Am I missing something here?
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I'm working on a project using PyO3 to build a Python library in Rust. For this project I'd like to generate good reference documentation directly from the docstrings embedded in the Rust code. As such, I set up reST code like this:
This gets me nicely documented methods for the type, but it seems that a docstring attached to a type itself (which does show up when using
help(ClientConfig)
in the REPL) does not make it into the generated docs. Am I missing something here?Beta Was this translation helpful? Give feedback.
All reactions