ICESAT-2HackWeek / coastal_topobathy

Team project aimed at extracting sections of tracklines, and identifying bathymetry and coastal morphology - can be extended to other questions!
https://icesat-2hackweek.github.io/coastal_topobathy/
4 stars 7 forks source link

nbconvert is running import code from examples #10

Open eeholmes opened 2 years ago

eeholmes commented 2 years ago

Reference this line in GitHub Action: https://github.com/ICESAT-2HackWeek/coastal_topobathy/blob/f027c497896080194583d322a7498f110b06ead4/.github/workflows/docs_pages.yml#L40

jupyter nbconvert is not supposed to execute the notebook and it doesn't seem to execute any code blocks except the first code block with imports. The other code blocks are not being run. See for example where you see the 'module not found error showing up' https://eeholmes.github.io/coastal_topobathy/examples/OpenAltimetry_example.html

Brainstorm of possible problems. Not that any of these really make sense but for the life of me I can't figure out why nbconvert is executing any of the code blocks!

iled commented 2 years ago

I don't know what is causing this issue, but an alternative would be doing the conversion to markdown through Jupytext

Use the MyST Markdown format, a markdown flavor that “implements the best parts of reStructuredText”, if you wish to render your notebooks using Sphinx or Jupyter Book.

eeholmes commented 2 years ago

Thanks I'll try jupytext conversion to markdown.
https://jupytext.readthedocs.io/en/latest/using-cli.html