-
Notifications
You must be signed in to change notification settings - Fork 10
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 Python docstring pages and publish them #10
Labels
Comments
We'll leave this open to future students who want to work on adding this. For now, we'll remove it from the milestone and leave it open. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@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.
The text was updated successfully, but these errors were encountered: