You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Since Sphinx v7.3.0, there is a warning about config values that are not pickleable. When building with warning_is_error = True, this fails the build. See sphinx-doc/sphinx#12300 for context.
For sphinx-autodoc-typehints, this means that a custom typehints_formatter leads to a build failure.
sphinx.errors.SphinxWarning: cannot cache unpickable configuration value: 'typehints_formatter' (because it contains a function, class, or module object) [config.cache]
Apart from triggering a warning that needs to be silenced, this also prevents caching. So it would be great to have a solution that avoids specifying a callable as typehints_formatter. One option would be using a fully qualified path and make sphinx-autodoc-typehints import a function from that path. E.g. typehints_formatter = 'mypackage.sphinxext.typehints_formatter'. See also this comment: sphinx-doc/sphinx#12300 (comment)
The text was updated successfully, but these errors were encountered:
Since Sphinx v7.3.0, there is a warning about config values that are not pickleable. When building with
warning_is_error = True
, this fails the build. See sphinx-doc/sphinx#12300 for context.For sphinx-autodoc-typehints, this means that a custom
typehints_formatter
leads to a build failure.To reproduce, simply use this
conf.py
:It results in this warning:
Apart from triggering a warning that needs to be silenced, this also prevents caching. So it would be great to have a solution that avoids specifying a callable as
typehints_formatter
. One option would be using a fully qualified path and make sphinx-autodoc-typehints import a function from that path. E.g.typehints_formatter = 'mypackage.sphinxext.typehints_formatter'
. See also this comment: sphinx-doc/sphinx#12300 (comment)The text was updated successfully, but these errors were encountered: