Syntax highlighting doesn't work for Python cells with magic

[marius311]

If I have a cell in a Python 3 notebook that says e.g.

%%time
# some python code

then when rendered with nbsphinx, the # some python code looses its syntax highlighting. Could it be made so that the syntax highlighting is kept, the same way it does in Jupyter notebook itself?

Some info about my setup incase its just a bug:

nbsphinx==0.2.9
Sphinx==1.4.6
ipython==5.1.0
jupyter-client==4.3.0
jupyter-core==4.1.1

[mgeier]

The Jupyter Notebook and nbconvert seem to handle that differently. nbsphinx is normally closer to nbconvert, since it uses a lot of code from there. I think the highlighting in the Jupyter Notebook is done with client-side JavaScript, which cannot be re-used in nbsphinx.

I just enabled processing of cell magics in #60. However, the %%time magic still has no syntax highlighting, same as in nbconvert.

The ipython3 lexer seems to disable syntax highlighting when a cell magic is present.

I just saw that this was already reported to nbconvert (jupyter/nbconvert#105) and ipython (ipython/ipython#9099). Once this is resolved, it should automatically work in nbsphinx, too.

[marius311]

Thats great, thanks for that. Will wait on the IPython fix then!

[uweschmitt]

Any updates here ? Still does not work with %%file.

[mgeier]

You should ask over there: ipython/ipython#9099

[mgeier]

It mostly works now, the missing %%file stuff should be fixed in ipython/ipython#11384.

[mgeier]

My PR has been merged, so I think this should be fine now.

If there is still some highlighting missing, please leave a comment!

[jeertmans]

Hello @mgeier, I'm commenting this because I have the same issue, on a custom magic.

The syntax highlighting within the Jupyter document works fine:

But, when renderer using nbsphinx, it does not work:

Any idea on how to fix that?

Versions info:

Name: nbsphinx                                      
Version: 0.9.2                                      
Summary: Jupyter Notebook Tools for Sphinx
Home-page: https://nbsphinx.readthedocs.io/
Author: Matthias Geier                              
Author-email: Matthias.Geier@gmail.com
License: MIT                                        
---                                                 
Name: ipykernel                                     
Version: 6.25.1                                     
Summary: IPython Kernel for Jupyter
Home-page:                                          
Author:                                             
Author-email: IPython Development Team <ipython-dev@scipy.org>
License: BSD 3-Clause License
---
Name: ipython
Version: 8.12.2
Summary: IPython: Productive Interactive Computing
Home-page: https://ipython.org
Author: The IPython Development Team
Author-email: ipython-dev@python.org
License: BSD-3-Clause

[mgeier]

What does nbconvert do?

See #59 (comment).

[jeertmans]

@mgeier nbconvert also fails: should I report that to them?

(Within the notebook viewer)

(When exported as HTML)

[mgeier]

nbconvert also fails: should I report that to them?

Yes, or maybe even to IPython, see e.g. ipython/ipython#9099 and ipython/ipython#11137.

[jeertmans]

@mgeier done :-)