From 34037aa4ad286fb941148363fd1db0236e357f4e Mon Sep 17 00:00:00 2001 From: CyrilRoelandteNovance Date: Mon, 20 Jan 2025 00:12:40 +0100 Subject: [PATCH] Allow users to suppress ``autodoc.mocked_object`` warnings (#9732) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> --- CHANGES.rst | 2 ++ doc/usage/configuration.rst | 6 ++++++ sphinx/ext/autodoc/__init__.py | 5 ++++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 69c4ada5cc1..3f263f2600c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -50,6 +50,8 @@ Features added pattern doesn't match any documents, via the new ``toc.glob_not_matching`` warning sub-type. Patch by Slawek Figiel. +* #9732: Add the new ``autodoc.mock_objects`` warnings sub-type. + Patch by Cyril Roelandt. Bugs fixed ---------- diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 40691c202cd..f0ec37ae541 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1404,6 +1404,7 @@ Options for warning control * ``autodoc`` * ``autodoc.import_object`` + * ``autodoc.mocked_object`` * ``autosectionlabel.`` * ``autosummary`` * ``autosummary.import_cycle`` @@ -1453,6 +1454,11 @@ Options for warning control .. versionadded:: 8.2 Added ``toc.empty_glob``. + .. versionadded:: 8.2 + + Added ``autodoc.mocked_object`` + + Builder options =============== diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 667ca4f4d8d..41d0f6cb68e 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1032,7 +1032,10 @@ def generate( ) if ismock(self.object) and not docstrings: logger.warning( - __('A mocked object is detected: %r'), self.name, type='autodoc' + __('A mocked object is detected: %r'), + self.name, + type='autodoc', + subtype='mocked_object', ) # check __module__ of object (for members not given explicitly)