-
Notifications
You must be signed in to change notification settings - Fork 2
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
Improve documentation #70
Conversation
@morcuended what do you recommend between available options (.ipynb + nbspinx, .myst + myst_nb, .py + sphinx-gallery)? |
62f9890
to
8a0e9c5
Compare
maybe sphinx-gallery? |
they were not displaying correctly because of the raw html links of the badges, probably because of sphinx_mdinclude bug
This reverts commit f63482d.
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
Co-authored-by: Daniel Morcuende <[email protected]>
so what's the problem with the downloading of test data? does it have a new checksum? |
It didn't set the credentials and checksum right, I think it will be solved in this CI run. |
If these the tests pass, I think it is good enough for now. We can keep improving the docs in other PRs with more example notebooks, etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, this is good to go already. Great job
This PR improves the documentation, adding several notebook examples.
The notebooks are implemented in 'pct' format, a fully text-based and human-readable format that is also valid Python code. They are automatically converted from pct format to usual ipynb by jupytext and executed by MyST-NB. They can be browsed as part of the normal documentation, they are integrated in the Sphinx docs through:
It also documents how to set up IOP4 for production (in a public server).
As of now the docs use the test dataset and catalog.