Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate user manual #48

Open
demisjohn opened this issue Apr 4, 2023 · 0 comments
Open

Generate user manual #48

demisjohn opened this issue Apr 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@demisjohn
Copy link
Owner

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

@demisjohn demisjohn added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Apr 4, 2023
@demisjohn demisjohn changed the title Need user manual Generate user manual Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant