Automatic API documentation generation? #1330
Samuel-Harris
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I'm a new user of DSPY and I've been finding incompleteness of the API docs to be very frustrating due to the lack of detail on many of the classes and functions, which would often force me to read the source code to understand how to use the library. I noticed that the API docs seem to be manually curated markdown files.
Have you considered making these automatically generating the API documentation, perhaps by using a docstring-to-markdown converter?
EDIT: corrected "pydocs-to-markdown" to "docstring-to-markdown"
Beta Was this translation helpful? Give feedback.
All reactions