Use Jupyter notebook as README #3

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

Open

leonlan opened this issue Feb 5, 2025 · 1 comment

Member

leonlan commented Feb 5, 2025

I want to minimize the effort on documentation. The easiest to do this is by having the Jupyter Notebook as README.

Member Author

leonlan commented Feb 20, 2025

Easiest to do:

Setup RTD with sphinx
Then include the notebook as page with nbsphinx

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