Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Generate user manual #48

Copy link
Copy link

Description

@demisjohn
Issue body actions

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

Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.