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.

Sign up for GitHub

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

Jump to bottom

Code documentation #2

Open

mattdowdell opened this issue Aug 25, 2016 · 1 comment

Labels

docs

Contributor

mattdowdell commented Aug 25, 2016

Documenting the code base would be helpful for anyone working on it. Auto-generated documentation based on comments would be even better.

Possible libraries:

yard
rdoc
tomdoc
- Used by github according to their styleguide

Contributor Author

mattdowdell commented Nov 8, 2016

Hosting of code docs can be done via github.io, by uploading HTML documentation to a gh-pages branch of this repository.

mattdowdell added the docs label

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