diff options
| -rw-r--r-- | CHANGES | 2 | ||||
| -rw-r--r-- | doc/usage/extensions/autodoc.rst | 6 | ||||
| -rw-r--r-- | sphinx/ext/autodoc/__init__.py | 3 | ||||
| -rw-r--r-- | sphinx/ext/autodoc/directive.py | 2 | ||||
| -rw-r--r-- | tests/test_ext_autodoc_autoattribute.py | 2 | ||||
| -rw-r--r-- | tests/test_ext_autodoc_autodata.py | 2 |
6 files changed, 12 insertions, 5 deletions
@@ -24,6 +24,8 @@ Bugs fixed ---------- * #10133: autodoc: Crashed when mocked module is used for type annotation +* #10146: autodoc: :confval:`autodoc_default_options` does not support + ``no-value`` option * #10122: sphinx-build: make.bat does not check the installation of sphinx-build command before showing help diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index dfb08e688..3849f4713 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -528,7 +528,8 @@ There are also config values that you can set: The supported options are ``'members'``, ``'member-order'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``, ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``, - ``'imported-members'``, ``'exclude-members'`` and ``'class-doc-from'``. + ``'imported-members'``, ``'exclude-members'``, ``'class-doc-from'`` and + ``'no-value'``. .. versionadded:: 1.8 @@ -541,6 +542,9 @@ There are also config values that you can set: .. versionchanged:: 4.1 Added ``'class-doc-from'``. + .. versionchanged:: 4.5 + Added ``'class-doc-from'``. + .. confval:: autodoc_docstring_signature Functions imported from C modules cannot be introspected, and therefore the diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 8a86f05b1..0e88d914c 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1001,7 +1001,8 @@ class ModuleDocumenter(Documenter): 'platform': identity, 'deprecated': bool_option, 'member-order': member_order_option, 'exclude-members': exclude_members_option, 'private-members': members_option, 'special-members': members_option, - 'imported-members': bool_option, 'ignore-module-all': bool_option + 'imported-members': bool_option, 'ignore-module-all': bool_option, + 'no-value': bool_option, } def __init__(self, *args: Any) -> None: diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index 8b8048f8a..0c040e1ef 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -30,7 +30,7 @@ logger = logging.getLogger(__name__) AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members', 'show-inheritance', 'private-members', 'special-members', 'ignore-module-all', 'exclude-members', 'member-order', - 'imported-members', 'class-doc-from'] + 'imported-members', 'class-doc-from', 'no-value'] AUTODOC_EXTENDABLE_OPTIONS = ['members', 'private-members', 'special-members', 'exclude-members'] diff --git a/tests/test_ext_autodoc_autoattribute.py b/tests/test_ext_autodoc_autoattribute.py index 9502b3c52..fec4da463 100644 --- a/tests/test_ext_autodoc_autoattribute.py +++ b/tests/test_ext_autodoc_autoattribute.py @@ -32,7 +32,7 @@ def test_autoattribute(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autoattribute_novalue(app): - options = {'no-value': True} + options = {'no-value': None} actual = do_autodoc(app, 'attribute', 'target.Class.attr', options) assert list(actual) == [ '', diff --git a/tests/test_ext_autodoc_autodata.py b/tests/test_ext_autodoc_autodata.py index 9fbfaaf39..7d6d9eb30 100644 --- a/tests/test_ext_autodoc_autodata.py +++ b/tests/test_ext_autodoc_autodata.py @@ -32,7 +32,7 @@ def test_autodata(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodata_novalue(app): - options = {'no-value': True} + options = {'no-value': None} actual = do_autodoc(app, 'data', 'target.integer', options) assert list(actual) == [ '', |