Adds python API reference #25
Conversation
|
doc build failing because of a bad docstring in the python creating a warning... |
There was a problem hiding this comment.
Looks good so far
-
Please see if the validators and config can be hidden in the Pydantic classes
-
The Developer API does not show the full docstring even though it is available
-
Is it possible to remove the type hints from function signature since they already exist in the docstring? This should make the signature less cluttered
There was a problem hiding this comment.
Looks better, Please see comments
Still got some typehints in outputs.rst
Enums don't show members
Also I think enums should be in the user API not developer. Also adding RAT.run to index.rst does not look great. We need to give RAT.run its own page or maybe merge with classlist.rst then rename the file.
|
@StephenNneji for some reason the type hints aren't suppressed if the class has no docstring. If I give the Results class a docstring and build the docs then it works as expected. I've created the issue RascalSoftware/python-RAT#130 to add docstrings to outputs |
StephenNneji
left a comment
StephenNneji
left a comment
There was a problem hiding this comment.
looks good, thanks
2 participants
This PR fixes #1 by adding an auto-generated Python API reference. A library autodoc-pydantic is used to build docs for Pydantic models!