-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Closed
Milestone
Description
Describe the bug
Our docs deployment has broken with the release of 8.2.0. I've started a PR to try and fix, but the last error we have is:
WARNING: The config value `napoleon_type_aliases' has type `dict'; expected `NoneType'.`
and I can't work out how to resolve it. The documentation says "Works only when napoleon_use_param = True." However, the error persists when this is set. The problem does not exist in sphinx 8.1.3. The upgrade to 8.2.0 also generated an issue with the current main dependency of sphinxcontrib.apidoc, but this is resolved in the PR by upgrading to sphinx.ext.apidoc
How to Reproduce
As per our setup file here:
pip install --upgrade setuptools pip
pip install --upgrade .
pip install -r requirements-docs.txt
mkdir -p doc/source/_static
sphinx-build -EnW -b html doc/source/ doc/build/html
Environment Information
python 3.12.3
sphinx 8.2.0
Sphinx extensions
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.autosectionlabel',
'sphinx.ext.apidoc',Additional context
No response