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

Repository review - Software documentation #12

Open

6 of 8 tasks

mwakok opened this issue Feb 16, 2024 · 0 comments

Labels

Member

mwakok commented Feb 16, 2024

Essential

Installation instructions
User documentation
Developer documentation
Source code documentation (docstrings)

Recommended

Examples and tutorials (Jupyter notebooks, videos, screencasts)
Automate documentation building with sphinx
Website (github.io pages, Readthedocs, JupyterBook)

Optional

Build API reference from docstrings

mwakok added the FAIR card label

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