IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: add new option to documentation

Browse Source
This commit is contained in:
gschwaer 2021-11-29 19:55:58 +01:00
parent 1caf4823f2
commit 33bebf5e87
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -23,6 +23,8 @@ Features added
layout via CSS
* #9899: py domain: Allows to specify cross-reference specifier (``.`` and
``~``) as ``:type:`` option
* #9792: autodoc: Add new option for ``autodoc_typehints_description_target`` to
include undocumented return values but not undocumented parameters.
Bugs fixed
----------

8
doc/usage/extensions/autodoc.rst
View File

@ -622,8 +622,16 @@ There are also config values that you can set:
When set to ``"documented"``, types will only be documented for a parameter
or a return value that is already documented by the docstring.
With ``"returnvalue_and_documented_params"``, parameter types will only be
annotated if the parameter is documented in the docstring. The return type is
always annotated (except if it is ``None``).
.. versionadded:: 4.0
.. versionadded:: 4.4
New option ``'returnvalue_and_documented_params'`` is added.
.. confval:: autodoc_type_aliases
A dictionary for users defined `type aliases`__ that maps a type name to the