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 Python docstring pages and publish them #10

Open
jwflory opened this issue Apr 20, 2016 · 1 comment
Open

Generate Python docstring pages and publish them #10

jwflory opened this issue Apr 20, 2016 · 1 comment

Comments

@jwflory
Copy link
Member

jwflory commented Apr 20, 2016

@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.

@jwflory jwflory self-assigned this Apr 20, 2016
@jwflory jwflory added this to the End of semester milestone Apr 20, 2016
@jwflory jwflory removed this from the End of semester milestone May 13, 2016
@jwflory
Copy link
Member Author

jwflory commented May 13, 2016

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
Projects
None yet
Development

No branches or pull requests

2 participants