ANN: Sphinx-4.1.0 is out

108 views
Skip to first unread message

Komiya Takeshi

unread,
Jul 11, 2021, 1:29:40 PM7/11/21
to sphinx...@googlegroups.com
Hi all,

Today, we released Sphinx-4.1.0. It contains many improvements and
bug fixes.

For more detail, please check the CHANGES file:
https://github.com/sphinx-doc/sphinx/blob/4.1.x/CHANGES

Enjoy documentation!

Thanks,
Takeshi KOMIYA

Luc Saffre

unread,
Jul 11, 2021, 2:40:23 PM7/11/21
to sphinx...@googlegroups.com, Komiya Takeshi
After upgrading, I have the following traceback and in all my doctrees, and I have no idea why. Neither "epub3" nor "RemovedInSphinx40Warning" occur in any of my source files. Any hints?

Luc

Invoke sphinx-build -b html -T -d /home/luc/mypy/lino_local/jsvv/docs/.build/.doctrees -W --keep-going . /home/luc/mypy/lino_local/jsvv/docs/.build
Running Sphinx v4.1.0
loading translations [et]... done

Traceback (most recent call last):
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/registry.py", line 429, in load_extension
    mod = import_module(extname)
  File "/home/luc/virtualenvs/py3/lib/python3.6/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 994, in _gcd_import
  File "<frozen importlib._bootstrap>", line 971, in _find_and_load
  File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 678, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/epub3.py", line 18, in <module>
    from sphinx.builders import _epub_base
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/_epub_base.py", line 23, in <module>
    from sphinx.builders.html import BuildInfo, StandaloneHTMLBuilder
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/html/__init__.py", line 1288, in <module>
    import sphinxcontrib.serializinghtml  # NOQA
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinxcontrib/serializinghtml/__init__.py", line 16, in <module>
    from sphinx.deprecation import RemovedInSphinx40Warning, deprecated_alias
ImportError: cannot import name 'RemovedInSphinx40Warning'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/cmd/build.py", line 279, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/application.py", line 233, in __init__
    self.setup_extension(extension)
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/application.py", line 393, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/registry.py", line 433, in load_extension
    err) from err
sphinx.errors.ExtensionError: Could not import extension sphinx.builders.epub3 (exception: cannot import name 'RemovedInSphinx40Warning')

Extension error:
Could not import extension sphinx.builders.epub3 (exception: cannot import name 'RemovedInSphinx40Warning')
C

jfbu

unread,
Jul 12, 2021, 5:20:30 PM7/12/21
to sphinx...@googlegroups.com
Le 11/07/2021 à 20:40, Luc Saffre a écrit :
> After upgrading, I have the following traceback and in all my doctrees,
> and I have no idea why. Neither "epub3" nor "RemovedInSphinx40Warning"
> occur in any of my source files. Any hints?
>
> Luc

Hi Luc

can you try

pip install -U sphinxcontrib.serializinghtml

in your virtual env ?

I think I encountered at my locale the same or similar
issue as yours, after having remained inactive with sphinx
for a while and trying out Sphinx 4.0.0

it got fixed by the above step (after having wasted some time in vain
looking through Sphinx sources for the cause)

fwiw at my locale I get this currently

Requirement already up-to-date: sphinxcontrib.serializinghtml in ./path/to/.venv38/lib/python3.8/site-packages (1.1.5)

Jean-François

jfbu

unread,
Jul 12, 2021, 5:30:06 PM7/12/21
to sphinx...@googlegroups.com
Le 12/07/2021 à 23:20, jfbu a écrit :
> Le 11/07/2021 à 20:40, Luc Saffre a écrit :
>> After upgrading, I have the following traceback and in all my doctrees,
>> and I have no idea why. Neither "epub3" nor "RemovedInSphinx40Warning"
>> occur in any of my source files. Any hints?
>>
>> Luc
>
> Hi Luc
>
> can you try
>
> pip install -U sphinxcontrib.serializinghtml
>
> in your virtual env ?

and perhaps same with sphinxcontrib.htmlhelp as I see I updated both on June 13

Requirement already up-to-date: sphinxcontrib.htmlhelp in ./Downloads/.venv38/lib/python3.8/site-packages (2.0.0)

jfbu

unread,
Jul 12, 2021, 5:40:34 PM7/12/21
to sphinx...@googlegroups.com
Le 12/07/2021 à 23:25, jfbu a écrit :
> Le 12/07/2021 à 23:20, jfbu a écrit :
>> Le 11/07/2021 à 20:40, Luc Saffre a écrit :
>>> After upgrading, I have the following traceback and in all my doctrees,
>>> and I have no idea why. Neither "epub3" nor "RemovedInSphinx40Warning"
>>> occur in any of my source files. Any hints?
>>>
>>> Luc
>>
>> Hi Luc
>>
>> can you try
>>
>> pip install -U sphinxcontrib.serializinghtml
>>
>> in your virtual env ?
>
> and perhaps same with sphinxcontrib.htmlhelp as I see I updated both on June 13
>
> Requirement already up-to-date: sphinxcontrib.htmlhelp in ./Downloads/.venv38/lib/python3.8/site-packages (2.0.0)


And I can confirm looking at old virtual environment I had still on my disk that its sphinxcontrib.serializinghtml (version 1.1.4) and .htmlhelp (version 1.0.3) __init.py each contain

from sphinx.deprecation import RemovedInSphinx40Warning

which triggers the error you see


I did not report it to Sphinx upstream because I felt I had messed around with my git clone based pip install -e approach to Sphinx installating in virtual env

so I don't know if something is wrong in handling of dependencies

hope it helps

Luc Saffre

unread,
Jul 12, 2021, 11:15:36 PM7/12/21
to sphinx...@googlegroups.com, jfbu
On 13.07.21 00:40, jfbu wrote:
pip install -U sphinxcontrib.serializinghtml

and perhaps same with sphinxcontrib.htmlhelp as I see I updated both on June 13


Yes, this fixed my problems. Great! Thanks!

Luc

Komiya Takeshi

unread,
Jul 14, 2021, 1:29:46 PM7/14/21
to Luc Saffre, sphinx...@googlegroups.com
Sorry for troubling on updating Sphinx. I just bumped Sphinx-4.1.1. It
can be installed without dependency troubles.

Thanks,
Takeshi KOMIYA

2021年7月12日(月) 3:40 Luc Saffre <luc.s...@gmail.com>:

Luc Saffre

unread,
Jul 14, 2021, 2:43:34 PM7/14/21
to Komiya Takeshi, sphinx...@googlegroups.com
Now it works perfectly. Thanks for your work!
Luc

Jeff McKenna

unread,
Jul 15, 2021, 4:15:32 PM7/15/21
to sphinx...@googlegroups.com
Thanks KOMIYA-san :)

-jeff



--
Jeff McKenna
GatewayGeo: Developers of MS4W, MapServer Consulting and Training
co-founder of FOSS4G
http://gatewaygeo.com/
Reply all
Reply to author
Forward
0 new messages