Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#33753 closed Bug (fixed)

Docs' Makefile doesn't support Sphinx 5+.

Reported by: Doug Hellmann Owned by: Mariusz Felisiak
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Checking out a clean copy of the main branch and running tox -e docs is failing with

$ tox -e docs
docs installed: alabaster==0.7.12,Babel==2.10.1,certifi==2022.5.18.1,charset-normalizer==2.0.12,docutils==0.18.1,idna==3.3,imagesize==1.3.0,Jinja2==3.1.2,MarkupSafe==2.1.1,packaging==21.3,pyenchant==3.2.2,Pygments==2.12.0,pyparsing==3.0.9,pytz==2022.1,requests==2.27.1,snowballstemmer==2.2.0,Sphinx==5.0.0,sphinxcontrib-applehelp==1.0.2,sphinxcontrib-devhelp==1.0.2,sphinxcontrib-htmlhelp==2.0.0,sphinxcontrib-jsmath==1.0.1,sphinxcontrib-qthelp==1.0.3,sphinxcontrib-serializinghtml==1.1.5,sphinxcontrib-spelling==7.4.1,urllib3==1.26.9
docs run-test-pre: PYTHONHASHSEED='4280851028'
docs run-test: commands[0] | make spelling
sphinx-build -b spelling -n -d _build/doctrees -D language=   . _build/spelling
Running Sphinx v5.0.0
loading translations []... not available for built-in messages
Initializing Spelling Checker 7.4.1
making output directory... done
Ignoring wiki words
Ignoring acronyms
Ignoring Python builtins
Ignoring importable module names
Ignoring contributor names
Looking for custom word list in /Users/dhellmann/Devel/sphinxcontrib-spelling/django/docs/spelling_wordlist
Scanning contributors
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv...
loading intersphinx inventory from https://www.psycopg.org/docs/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [spelling]: all documents
updating environment: [new config] 537 added, 0 changed, 0 removed
reading sources... [  0%] contents

Exception occurred:
  File "<frozen importlib._bootstrap>", line 981, in _sanity_check
ValueError: Empty module name
The full traceback has been saved in /var/folders/5q/8gk0wq888xlggz008k8dr7180000hg/T/sphinx-err-5nedfmq7.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [spelling] Error 2

Sphinx 5.0.0 was just released, and this build was working yesterday, so I suspect it's a backwards-incompatible change in Sphinx's behavior.

This failure is blocking changes in sphinxcontrib-spelling (see https://github.com/sphinx-contrib/spelling/runs/6657712458?check_suite_focus=true for example), so I have removed that job from the required list for now. When the docs build here is working again, I'll restore it.

Change History (8)

comment:1 by Doug Hellmann, 2 years ago

https://github.com/sphinx-contrib/spelling/pull/176 will restore the disabled job on sphinxcontrib-spelling.

comment:2 by Mariusz Felisiak, 2 years ago

Owner: changed from nobody to Mariusz Felisiak
Status: newassigned
Summary: documentation build failing with "ValueError: Empty module name"Docs' Makefile doesn't support Sphinx 5+.
Triage Stage: UnreviewedAccepted
Version: 4.0dev

Thanks for the report. It looks like a backward incompatible change in the language setting. We should set a default language when the LANGUAGE environment variable is set to LANGUAGE=.

comment:3 by Mariusz Felisiak, 2 years ago

Has patch: set

comment:4 by Carlton Gibson, 2 years ago

Triage Stage: AcceptedReady for checkin

comment:5 by GitHub <noreply@…>, 2 years ago

Resolution: fixed
Status: assignedclosed

In 565ad5ac:

Fixed #33753 -- Fixed docs build on Sphinx 5+.

Empty language is not supported anymore.

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 2 years ago

In 007a21b5:

[4.1.x] Fixed #33753 -- Fixed docs build on Sphinx 5+.

Empty language is not supported anymore.
Backport of 565ad5ace46aa1e2368450701cba45dd1a95a026 from main

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 2 years ago

In bc38eafc:

[4.0.x] Fixed #33753 -- Fixed docs build on Sphinx 5+.

Empty language is not supported anymore.
Backport of 565ad5ace46aa1e2368450701cba45dd1a95a026 from main

comment:8 by Mariusz Felisiak <felisiak.mariusz@…>, 2 years ago

In a23c25d8:

[3.2.x] Fixed #33753 -- Fixed docs build on Sphinx 5+.

Empty language is not supported anymore.
Backport of 565ad5ace46aa1e2368450701cba45dd1a95a026 from main

Note: See TracTickets for help on using tickets.
Back to Top