Merge pull request #9399 from tk0miya/napoleon_preprocess_types

doc: Fix the default value of napoleon_preprocess_types is True
This commit is contained in:
Takeshi KOMIYA 2021-07-04 11:26:43 +09:00 committed by GitHub
commit 0ee0d8df00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -509,7 +509,7 @@ sure that "sphinx.ext.napoleon" is enabled in `conf.py`::
.. confval:: napoleon_preprocess_types
True to convert the type definitions in the docstrings as references.
Defaults to *True*.
Defaults to *False*.
.. versionadded:: 3.2.1
.. versionchanged:: 3.5