spatialaudio / nbsphinx

:ledger: Sphinx source parser for Jupyter notebooks
https://nbsphinx.readthedocs.io/
MIT License
451 stars 130 forks source link

Bullet points are not rendering in furo theme. #574

Closed kolibril13 closed 3 years ago

kolibril13 commented 3 years ago

In my notebook I have bullet points, that are getting rendered to bullet points locally, but not in the Spinx build with nbsphinx. Rendered: https://flyingframes.readthedocs.io/en/latest/ch1.html notebook in GitHub: https://github.com/kolibril13/flyingframes/blob/main/docs/source/ch1.ipynb However, on the nbsphinx website, it is shown properly: https://nbsphinx.readthedocs.io/en/furo-theme/markdown-cells.html Any ideas what I can do? It does not bother me a lot, so if it requires big workarounds, I am fine to have bullet points only be displayed by stars.

mgeier commented 3 years ago

Did you try removing the trailing double-spaces?

kolibril13 commented 3 years ago

Thanks for your reply! I have just removed the trailing double-spaces, and now it looks like this: It actually became worse 😄 image https://flyingframes.readthedocs.io/en/latest/ch1.html (link from 16.6.2021) But in the local notebook, it still looks fine: https://github.com/kolibril13/flyingframes/blob/main/docs/source/ch1.ipynb

mgeier commented 3 years ago

There is still a double space in the line before the list.

kolibril13 commented 3 years ago

ok, now I removed all spaces, but the problem is still there: https://flyingframes.readthedocs.io/en/latest/ch1.html

mgeier commented 3 years ago

Hmmm, what about adding a blank line before the list?

The problem is that JupyterLab (and the classic Notebook app) uses a different Markdown parser than nbsphinx (which currently uses Pandoc). So there might be slight differences in how Markdown features are interpreted.

kolibril13 commented 3 years ago

Great! Thanks a lot, that solved my problem! :)