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

[REQUEST]: Readthedocs documentation for both front- and backend #30

Open
1 task done
johannesnauta opened this issue Aug 30, 2022 · 0 comments
Open
1 task done
Labels
enhancement New feature or request

Comments

@johannesnauta
Copy link
Contributor

johannesnauta commented Aug 30, 2022

Is this feature already implemented or suggested?

  • I have determined this suggested feature is novel

Suggested feature

If our aim is to have others contribute to this project, we need to provide clear and thorough documentation. Note that good documentation will also be beneficial for us in the future!

  • Backend: As the backend is Python, Sphinx documentation is widely available.
  • Frontend: For the Javascript frontend, we might use something like Sphinx-js to ensure consistency throughout.

❗ Note that when providing clear documentation, we need to decide upon a documentation style. I personally like numpydoc, but if we do not use NumPy a lot we can switch to other options. At least we should try to be as consistent as possible throughout the entire project.

@johannesnauta johannesnauta added the enhancement New feature or request label Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant