alchemyst / Dynamics-and-Control

Jupyter notebooks for Dynamics and Control
GNU General Public License v3.0
267 stars 141 forks source link

Add ipykernel to Sphinx requirements #16

Closed mgeier closed 3 years ago

mgeier commented 3 years ago

I'm not sure whether this is sufficient, but with a bit of luck, this will lead to a working syntax highlighting in code cells.

See also https://nbsphinx.readthedocs.io/en/latest/installation.html#Pygments-Lexer-for-Syntax-Highlighting.

mgeier commented 3 years ago

And it would be helpful to enable this: https://docs.readthedocs.io/en/latest/guides/autobuild-docs-for-pull-requests.html, then we could see whether it actually works.

alchemyst commented 3 years ago

Thank you very much for this, @mgeier. Unfortunately I think the read the docs builds have not run successfully in a very long time. IIRC the issue at the time was with Unicode variable names (like using ɑ instead of alpha). I have enabled the autobuild though.

mgeier commented 3 years ago

It seems to have worked fine: https://readthedocs.org/projects/dynamics-and-control/builds/12704317/

Now syntax highlighting works!

But now the code background is ugly, see #17.