jupyter-sphinx icon indicating copy to clipboard operation
jupyter-sphinx copied to clipboard

No directive entry for "jupyter-execute" in module "docutils.parsers.rst.languages.en".

Open niketagrawal opened this issue 5 years ago • 1 comments

Description

The below warning is highlighted by the linter when jupyter-sphinx extension is used to embed python code in the documentation generated using sphinx on a Windows 10 PC.

(INFO/1) No directive entry for "jupyter-execute" in module "docutils.parsers.rst.languages.en".

What does this imply in the context of using the jupyter-sphinx extension on Windows? Is there anything that needs to be configured to ensure the extension can be used successfully?

Setup:

Windows 10 conda 4.8.3 Python 3.8.6 sphinx 3.3.1 jupyter-sphinx 0.3.2

Steps to reproduce

  • Create a conda virtual environment, activate it and install sphinx and jupyter-sphinx
$ conda create --name=jupyter-sphinx-test python=3.8
$ conda activate jupyter-sphinx-test
$ conda install -c anaconda sphinx
$ conda install jupyter_sphinx
  • Create a new directory named docs and generate the basic sphinx documentation template inside it.
$ mkdir docs
$ cd docs
$ sphinx-quickstart
  • Append the index.rst file generated from the above step with the below python code segment using the jupyter-execute directive.
.. jupyter-execute::

  print('hello ')
  • Enable the jupyter-sphinx extension in conf.py
extensions = [
    'jupyter_sphinx.execute',
]

Note: The documentation build threw a warning suggesting to replace jupyter_sphinx.execute with jupyter_sphinx. However, the linter warning stays even after making the suggested change.

niketagrawal avatar Nov 25 '20 11:11 niketagrawal

I don't have a windows machine myself and it seems everything is running fine in our test suit. Are you still experimenting this bug from your side ?

12rambau avatar Dec 29 '23 17:12 12rambau