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

Use MyST-NB to render jupyter notebook and markdown files #196

Merged
merged 54 commits into from
Dec 21, 2021

Commits on Dec 14, 2021

  1. 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.
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    936d64f View commit details
    Browse the repository at this point in the history
  2. Make code of conduct link show up on sidebar

    Use MyST markdown parser instead of reStructuredText parser.
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    5b62759 View commit details
    Browse the repository at this point in the history
  3. Remove unused layout template

    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    b61a057 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    142b94c View commit details
    Browse the repository at this point in the history
  5. 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).
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    7998f7d View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    6bcb7c1 View commit details
    Browse the repository at this point in the history
  7. 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!
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    7da1e95 View commit details
    Browse the repository at this point in the history
  8. 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.
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    6e1e22b View commit details
    Browse the repository at this point in the history
  9. 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).
    weiji14 authored and JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    3f5c527 View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    d63119e View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    67c213e View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    1f547e3 View commit details
    Browse the repository at this point in the history
  13. Configuration menu
    Copy the full SHA
    335fcef View commit details
    Browse the repository at this point in the history
  14. Configuration menu
    Copy the full SHA
    82c4b18 View commit details
    Browse the repository at this point in the history
  15. use toc tree directive

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    600cc7c View commit details
    Browse the repository at this point in the history
  16. Configuration menu
    Copy the full SHA
    17080db View commit details
    Browse the repository at this point in the history
  17. Configuration menu
    Copy the full SHA
    1453dce View commit details
    Browse the repository at this point in the history
  18. Configuration menu
    Copy the full SHA
    1be21a0 View commit details
    Browse the repository at this point in the history
  19. fix DEM example filename

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    e6a1555 View commit details
    Browse the repository at this point in the history
  20. Configuration menu
    Copy the full SHA
    eca6851 View commit details
    Browse the repository at this point in the history
  21. Configuration menu
    Copy the full SHA
    9bec2ae View commit details
    Browse the repository at this point in the history
  22. try re-adding example link

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    1703a0e View commit details
    Browse the repository at this point in the history
  23. try re-adding example link

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    c7e9916 View commit details
    Browse the repository at this point in the history
  24. remove dev notebooks

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    efb4a64 View commit details
    Browse the repository at this point in the history
  25. Configuration menu
    Copy the full SHA
    2a6299b View commit details
    Browse the repository at this point in the history
  26. Configuration menu
    Copy the full SHA
    b1f1b80 View commit details
    Browse the repository at this point in the history
  27. Configuration menu
    Copy the full SHA
    841be70 View commit details
    Browse the repository at this point in the history
  28. Configuration menu
    Copy the full SHA
    663b477 View commit details
    Browse the repository at this point in the history
  29. Configuration menu
    Copy the full SHA
    f5dc0e5 View commit details
    Browse the repository at this point in the history
  30. Configuration menu
    Copy the full SHA
    a7aebca View commit details
    Browse the repository at this point in the history
  31. remove example link rst

    JessicaS11 committed Dec 14, 2021
    Configuration menu
    Copy the full SHA
    b47f44c View commit details
    Browse the repository at this point in the history
  32. Configuration menu
    Copy the full SHA
    72cb9d4 View commit details
    Browse the repository at this point in the history
  33. Configuration menu
    Copy the full SHA
    d690453 View commit details
    Browse the repository at this point in the history
  34. Configuration menu
    Copy the full SHA
    d226b4f View commit details
    Browse the repository at this point in the history

Commits on Dec 15, 2021

  1. fix heading level

    JessicaS11 committed Dec 15, 2021
    Configuration menu
    Copy the full SHA
    66032ac View commit details
    Browse the repository at this point in the history

Commits on Dec 16, 2021

  1. Configuration menu
    Copy the full SHA
    fa815d6 View commit details
    Browse the repository at this point in the history
  2. try decreasing maxdepth

    JessicaS11 committed Dec 16, 2021
    Configuration menu
    Copy the full SHA
    323235f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    2072419 View commit details
    Browse the repository at this point in the history
  4. Revert "decrease examples.rst maxdepth"

    This reverts commit 2072419.
    JessicaS11 committed Dec 16, 2021
    Configuration menu
    Copy the full SHA
    3c04e2e View commit details
    Browse the repository at this point in the history

Commits on Dec 20, 2021

  1. Configuration menu
    Copy the full SHA
    4ecc192 View commit details
    Browse the repository at this point in the history
  2. Fix code of conduct link

    weiji14 committed Dec 20, 2021
    Configuration menu
    Copy the full SHA
    fd237e7 View commit details
    Browse the repository at this point in the history
  3. Fix changelog rst errors

    weiji14 committed Dec 20, 2021
    Configuration menu
    Copy the full SHA
    846d7cf View commit details
    Browse the repository at this point in the history
  4. Increase jupyter notebook section heading levels

    Prevents `WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]` when building docs.
    weiji14 committed Dec 20, 2021
    Configuration menu
    Copy the full SHA
    db480e7 View commit details
    Browse the repository at this point in the history
  5. 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 ...`
    weiji14 committed Dec 20, 2021
    Configuration menu
    Copy the full SHA
    340d47c View commit details
    Browse the repository at this point in the history

Commits on Dec 21, 2021

  1. Turn examples into a dedicated section

    Increase visibility of the jupyter notebook examples on the readthedocs page.
    weiji14 committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    a161b42 View commit details
    Browse the repository at this point in the history
  2. Revert "Fix code of conduct link"

    This reverts commit fd237e7.
    JessicaS11 committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    3b003bb View commit details
    Browse the repository at this point in the history
  3. fix code of conduct link

    JessicaS11 committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    541caf6 View commit details
    Browse the repository at this point in the history
  4. Revert "Turn examples into a dedicated section"

    This reverts commit a161b42.
    JessicaS11 committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    e478588 View commit details
    Browse the repository at this point in the history
  5. Revert "Increase jupyter notebook section heading levels"

    This reverts commit db480e7.
    JessicaS11 committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    77a93b1 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    2cbf85b View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    4ca39d8 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    22db87d View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    01fd47f View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    388f843 View commit details
    Browse the repository at this point in the history