-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
I would like to write a user manual that lists all available functions in each class, and includes the examples shown in the GitHub and in code files in the repo.
All functions already have somewhat descriptive docstrings, should use those to generate the user manual.
I believe there is some way to auto-generate class methods with docstrings into a HTML or Markdown page? Let me know if anyone knows how to do this.
Here is an example of what must be an auto-generated user guide (presumably from the docstrings of each function?):
https://matplotlib.org/stable/api/index.html
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed