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

docs: provide documentation on readthedocs #324

Open

6 tasks

ap-- opened this issue Dec 16, 2024 · 0 comments

Labels

documentation 📘 maintenance 🚧

Collaborator

ap-- commented Dec 16, 2024

Should start hosting documentation on RTD.

decide between sphinx and mkdocs
port the readme to the hosted docs and reduce the readme to a quickstart section
ingest the example notebook as a tutorial section
add ci job for deploying the docs
add links to readme
add project owners to rtd project

ap-- added documentation 📘 maintenance 🚧 labels

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