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

Documentation #1

Open

TheChymera opened this issue Apr 22, 2020 · 0 comments

TheChymera commented Apr 22, 2020

It is preferable to not start listing the submodules in the README as a quasi-documentation.

The documentation should be:

In the function strings
If you want to create a nicer set of documentation for the user (which will also most def be required if we end up submitting to JOSS), look into “readthedocs” and how we did it for COSplay. It's a bit of a pain in the ass, but it looks really nice and navigable once it's done.

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