Skip to content

Generate Python docstring pages and publish them #10

Description

@justwheel

@wilfriedE has been documenting some of the project with Python docstrings. None of us in the project are extremely familiar with them or if you can generate a "pretty page" for them, like you might with JavaDocs HTML pages. Part of this task is for me to research if it's possible to generate some kind of page like this from the docstrings that are in the code.

If this is possible, we can use GitHub pages to host the docstring pages for reference later. This can be considered a "stretch goal". It may not be possible to do this, but if so, it would be nice to have.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions