Context Navigation

← Previous Ticket
Next Ticket →

#34756 closed Cleanup/optimization (fixed)

Docs build failure when using Sphinx 7.1.1

Reported by:	Natalia Bidart	Owned by:	David Smith
Component:	Documentation	Version:	4.2
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

While preparing the release of Django 4.2.4, I built the docs in the main and stable/4.2.x branches and in both I got this error (Sphinx 7.1.1. was released 5 days ago):

(djangodev) [nessita@socrates 0 ~/fellowship/django/docs main|⚑ 1]$ make html
sphinx-build -b djangohtml -n -d _build/doctrees -D language=en   . _build/html
Running Sphinx v7.1.1
making output directory... done
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/psycopg3/docs/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [djangohtml]: targets for 567 source files that are out of date
updating environment: [new config] 567 added, 0 changed, 0 removed
reading sources... [100%] topics/testing/tools
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [  2%] howto/custom-file-storage
Exception occurred:
  File "/home/nessita/.virtualenvs/djangodev/lib/python3.11/site-packages/sphinx/writers/html5.py", line 206, in visit_desc_parameter
    on_separate_line = self.multi_line_parameter_list
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'DjangoHTMLTranslator' object has no attribute 'multi_line_parameter_list'
The full traceback has been saved in /tmp/sphinx-err-2385y4w7.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: *** [Makefile:59: html] Error 2

I then downgraded Sphinx to 7.0.1 and the built succeeded. I will debug further after the release, I want to confirm if this is something in our code or if there is an issue that should be reported to Sphinx upstream. Nevertheless, I'm creating this ticket to keep track of the error and resolution.