-
Notifications
You must be signed in to change notification settings - Fork 108
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
Use MyST-NB to render jupyter notebook and markdown files #196
Commits on Dec 14, 2021
-
Use MyST-NB to render jupyter notebook and markdown files
MyST-NB parses jupyter notebooks and markdown in Sphinx, thereby replacing nbsphinx (for .ipynb files) and recommonmark (for .md files). The powerful MyST (Markedly Structured Text) parser also allows much of the documentation to be written in Markdown instead of reStructuredText, which can make it easier for new folks wanting to make contributions to the documentation.
Configuration menu - View commit details
-
Copy full SHA for 936d64f - Browse repository at this point
Copy the full SHA 936d64fView commit details -
Make code of conduct link show up on sidebar
Use MyST markdown parser instead of reStructuredText parser.
Configuration menu - View commit details
-
Copy full SHA for 5b62759 - Browse repository at this point
Copy the full SHA 5b62759View commit details -
Configuration menu - View commit details
-
Copy full SHA for b61a057 - Browse repository at this point
Copy the full SHA b61a057View commit details -
Use Sphinx's built-in Napolean extension instead of numpydoc
Gets rid of autosummary toctree warnings, see https://stackoverflow.com/questions/12206334/sphinx-autosummary-toctree-contains-reference-to-nonexisting-document-warnings/43237890#43237890. Also need to add sphinx autosummary extension I think.
Configuration menu - View commit details
-
Copy full SHA for 142b94c - Browse repository at this point
Copy the full SHA 142b94cView commit details -
Fix API docs links by putting .rst first in sphinx conf.py
API docs didn't have proper links because *.ipynb files were generated instead of *.rst files, some buggy hardcoding apparently. Workaround is to put the ".rst" line first in Sphinx's conf.py. Also removed a numpydoc config, and ensure API docs are generated to doc/source/_icepyx (which is gitignored).
Configuration menu - View commit details
-
Copy full SHA for 7998f7d - Browse repository at this point
Copy the full SHA 7998f7dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 6bcb7c1 - Browse repository at this point
Copy the full SHA 6bcb7c1View commit details -
Move DAAC DataAccess example to doc/source/example_notebooks
Put the rendered ICESat-2_DAAC_DataAccess_Example jupyter notebook in the User Guide! No need to visit GitHub to see the jupyter notebook anymore!
Configuration menu - View commit details
-
Copy full SHA for 7da1e95 - Browse repository at this point
Copy the full SHA 7da1e95View commit details -
Add linkify MyST extension to convert bare URLs to actual hyperlinks
See https://myst-parser.readthedocs.io/en/v0.13.6/using/syntax-optional.html#linkify. Converts https URLs into clickable links, e.g. those at the end of the Code of Conduct page.
Configuration menu - View commit details
-
Copy full SHA for 6e1e22b - Browse repository at this point
Copy the full SHA 6e1e22bView commit details -
Automatically create targets for section headers
See https://myst-parser.readthedocs.io/en/v0.13.6/using/howto.html#automatically-create-targets-for-section-headers. Fixes WARNING: duplicate label xxx, other instance in yyy (mostly in the changelog page).
Configuration menu - View commit details
-
Copy full SHA for 3f5c527 - Browse repository at this point
Copy the full SHA 3f5c527View commit details -
Configuration menu - View commit details
-
Copy full SHA for d63119e - Browse repository at this point
Copy the full SHA d63119eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 67c213e - Browse repository at this point
Copy the full SHA 67c213eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1f547e3 - Browse repository at this point
Copy the full SHA 1f547e3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 335fcef - Browse repository at this point
Copy the full SHA 335fcefView commit details -
Configuration menu - View commit details
-
Copy full SHA for 82c4b18 - Browse repository at this point
Copy the full SHA 82c4b18View commit details -
Configuration menu - View commit details
-
Copy full SHA for 600cc7c - Browse repository at this point
Copy the full SHA 600cc7cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 17080db - Browse repository at this point
Copy the full SHA 17080dbView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1453dce - Browse repository at this point
Copy the full SHA 1453dceView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1be21a0 - Browse repository at this point
Copy the full SHA 1be21a0View commit details -
Configuration menu - View commit details
-
Copy full SHA for e6a1555 - Browse repository at this point
Copy the full SHA e6a1555View commit details -
Configuration menu - View commit details
-
Copy full SHA for eca6851 - Browse repository at this point
Copy the full SHA eca6851View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9bec2ae - Browse repository at this point
Copy the full SHA 9bec2aeView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1703a0e - Browse repository at this point
Copy the full SHA 1703a0eView commit details -
Configuration menu - View commit details
-
Copy full SHA for c7e9916 - Browse repository at this point
Copy the full SHA c7e9916View commit details -
Configuration menu - View commit details
-
Copy full SHA for efb4a64 - Browse repository at this point
Copy the full SHA efb4a64View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2a6299b - Browse repository at this point
Copy the full SHA 2a6299bView commit details -
Configuration menu - View commit details
-
Copy full SHA for b1f1b80 - Browse repository at this point
Copy the full SHA b1f1b80View commit details -
Configuration menu - View commit details
-
Copy full SHA for 841be70 - Browse repository at this point
Copy the full SHA 841be70View commit details -
Configuration menu - View commit details
-
Copy full SHA for 663b477 - Browse repository at this point
Copy the full SHA 663b477View commit details -
Configuration menu - View commit details
-
Copy full SHA for f5dc0e5 - Browse repository at this point
Copy the full SHA f5dc0e5View commit details -
Configuration menu - View commit details
-
Copy full SHA for a7aebca - Browse repository at this point
Copy the full SHA a7aebcaView commit details -
Configuration menu - View commit details
-
Copy full SHA for b47f44c - Browse repository at this point
Copy the full SHA b47f44cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 72cb9d4 - Browse repository at this point
Copy the full SHA 72cb9d4View commit details -
Configuration menu - View commit details
-
Copy full SHA for d690453 - Browse repository at this point
Copy the full SHA d690453View commit details -
Configuration menu - View commit details
-
Copy full SHA for d226b4f - Browse repository at this point
Copy the full SHA d226b4fView commit details
Commits on Dec 15, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 66032ac - Browse repository at this point
Copy the full SHA 66032acView commit details
Commits on Dec 16, 2021
-
Configuration menu - View commit details
-
Copy full SHA for fa815d6 - Browse repository at this point
Copy the full SHA fa815d6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 323235f - Browse repository at this point
Copy the full SHA 323235fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2072419 - Browse repository at this point
Copy the full SHA 2072419View commit details -
Revert "decrease examples.rst maxdepth"
This reverts commit 2072419.
Configuration menu - View commit details
-
Copy full SHA for 3c04e2e - Browse repository at this point
Copy the full SHA 3c04e2eView commit details
Commits on Dec 20, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 4ecc192 - Browse repository at this point
Copy the full SHA 4ecc192View commit details -
Configuration menu - View commit details
-
Copy full SHA for fd237e7 - Browse repository at this point
Copy the full SHA fd237e7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 846d7cf - Browse repository at this point
Copy the full SHA 846d7cfView commit details -
Increase jupyter notebook section heading levels
Prevents `WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]` when building docs.
Configuration menu - View commit details
-
Copy full SHA for db480e7 - Browse repository at this point
Copy the full SHA db480e7View commit details -
Remove duplicate headings in data variables notebook
Fixes `WARNING: duplicate label getting_started/example_notebooks/working_with_icesat-2_data_variables:example 1: choose variables, other instance in ...`
Configuration menu - View commit details
-
Copy full SHA for 340d47c - Browse repository at this point
Copy the full SHA 340d47cView commit details
Commits on Dec 21, 2021
-
Turn examples into a dedicated section
Increase visibility of the jupyter notebook examples on the readthedocs page.
Configuration menu - View commit details
-
Copy full SHA for a161b42 - Browse repository at this point
Copy the full SHA a161b42View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3b003bb - Browse repository at this point
Copy the full SHA 3b003bbView commit details -
Configuration menu - View commit details
-
Copy full SHA for 541caf6 - Browse repository at this point
Copy the full SHA 541caf6View commit details -
Revert "Turn examples into a dedicated section"
This reverts commit a161b42.
Configuration menu - View commit details
-
Copy full SHA for e478588 - Browse repository at this point
Copy the full SHA e478588View commit details -
Revert "Increase jupyter notebook section heading levels"
This reverts commit db480e7.
Configuration menu - View commit details
-
Copy full SHA for 77a93b1 - Browse repository at this point
Copy the full SHA 77a93b1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2cbf85b - Browse repository at this point
Copy the full SHA 2cbf85bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 4ca39d8 - Browse repository at this point
Copy the full SHA 4ca39d8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 22db87d - Browse repository at this point
Copy the full SHA 22db87dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 01fd47f - Browse repository at this point
Copy the full SHA 01fd47fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 388f843 - Browse repository at this point
Copy the full SHA 388f843View commit details