Merge branch '4.x' into 9529_named_footnotes_in_latex

CHANGES

@@ -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
 * #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
   multiple times was rendered to a question mark
 * #10122: sphinx-build: make.bat does not check the installation of sphinx-build
@@ -50,6 +52,9 @@ Features added
 Bugs fixed
 ----------
 
+* #9876: autodoc: Failed to document an imported class that is built from native
+  binary module
+
 Testing
 --------
 

doc/development/theming.rst

@@ -88,8 +88,8 @@ Python :mod:`ConfigParser` module) and has the following structure:
 Distribute your theme as a Python package
 -----------------------------------------
 
-As a way to distribute your theme, you can use Python package.  Python package
-brings to users easy setting up ways.
+As a way to distribute your theme, you can use a Python package.  This makes it
+easier for users to set up your theme.
 
 To distribute your theme as a Python package, please define an entry point
 called ``sphinx.html_themes`` in your ``setup.py`` file, and write a ``setup()``

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 ``'no-value'``.
+
 .. confval:: autodoc_docstring_signature
 
    Functions imported from C modules cannot be introspected, and therefore the

doc/usage/restructuredtext/basics.rst

@@ -245,10 +245,10 @@ follow:
 
 * ``#`` with overline, for parts
 * ``*`` with overline, for chapters
-* ``=``, for sections
-* ``-``, for subsections
-* ``^``, for subsubsections
-* ``"``, for paragraphs
+* ``=`` for sections
+* ``-`` for subsections
+* ``^`` for subsubsections
+* ``"`` for paragraphs
 
 Of course, you are free to use your own marker characters (see the reST
 documentation), and use a deeper nesting level, but keep in mind that most

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:
@@ -1771,9 +1772,12 @@ def get_variable_comment(self) -> Optional[List[str]]:
     def add_content(self, more_content: Optional[StringList], no_docstring: bool = False
                     ) -> None:
         if self.doc_as_attr and self.modname != self.get_real_modname():
-            # override analyzer to obtain doccomment around its definition.
-            self.analyzer = ModuleAnalyzer.for_module(self.modname)
-            self.analyzer.analyze()
+            try:
+                # override analyzer to obtain doccomment around its definition.
+                self.analyzer = ModuleAnalyzer.for_module(self.modname)
+                self.analyzer.analyze()
+            except PycodeError:
+                pass
 
         if self.doc_as_attr and not self.get_variable_comment():
             try:

sphinx/ext/autodoc/directive.py

@@ -30,7 +30,7 @@
 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']

sphinx/locale/ar/LC_MESSAGES/sphinx.po

@@ -9,7 +9,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Sphinx\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2022-01-30 00:11+0000\n"
+"POT-Creation-Date: 2022-02-06 00:13+0000\n"
 "PO-Revision-Date: 2022-01-23 00:11+0000\n"
 "Last-Translator: Komiya Takeshi <i.tkomiya@gmail.com>\n"
 "Language-Team: Arabic (http://www.transifex.com/sphinx-doc/sphinx-1/language/ar/)\n"
@@ -2616,7 +2616,7 @@ msgid ""
 "====================== slowest reading durations ======================="
 msgstr ""
 
-#: sphinx/ext/extlinks.py:76
+#: sphinx/ext/extlinks.py:77
 #, python-format
 msgid ""
 "hardcoded link %r could be replaced by an extlink (try using %r instead)"
@@ -3407,19 +3407,19 @@ msgstr ""
 msgid "Other changes"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:199 sphinx/writers/html.py:437
-#: sphinx/writers/html.py:442 sphinx/writers/html5.py:392
-#: sphinx/writers/html5.py:397
+#: sphinx/themes/basic/static/doctools.js:197 sphinx/writers/html.py:436
+#: sphinx/writers/html.py:441 sphinx/writers/html5.py:395
+#: sphinx/writers/html5.py:400
 msgid "Permalink to this headline"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:205 sphinx/writers/html.py:132
-#: sphinx/writers/html.py:141 sphinx/writers/html5.py:107
+#: sphinx/themes/basic/static/doctools.js:203 sphinx/writers/html.py:128
+#: sphinx/writers/html.py:137 sphinx/writers/html5.py:107
 #: sphinx/writers/html5.py:116
 msgid "Permalink to this definition"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:238
+#: sphinx/themes/basic/static/doctools.js:236
 msgid "Hide Search Matches"
 msgstr ""
 
@@ -3595,37 +3595,37 @@ msgstr ""
 msgid "default role %s not found"
 msgstr ""
 
-#: sphinx/writers/html.py:330 sphinx/writers/html5.py:305
+#: sphinx/writers/html.py:329 sphinx/writers/html5.py:308
 #, python-format
 msgid "numfig_format is not defined for %s"
 msgstr ""
 
-#: sphinx/writers/html.py:340 sphinx/writers/html5.py:315
+#: sphinx/writers/html.py:339 sphinx/writers/html5.py:318
 #, python-format
 msgid "Any IDs not assigned for %s node"
 msgstr ""
 
-#: sphinx/writers/html.py:414 sphinx/writers/html5.py:369
+#: sphinx/writers/html.py:413 sphinx/writers/html5.py:372
 msgid "Permalink to this term"
 msgstr ""
 
-#: sphinx/writers/html.py:446 sphinx/writers/html5.py:401
+#: sphinx/writers/html.py:445 sphinx/writers/html5.py:404
 msgid "Permalink to this table"
 msgstr ""
 
-#: sphinx/writers/html.py:489 sphinx/writers/html5.py:444
+#: sphinx/writers/html.py:488 sphinx/writers/html5.py:447
 msgid "Permalink to this code"
 msgstr ""
 
-#: sphinx/writers/html.py:491 sphinx/writers/html5.py:446
+#: sphinx/writers/html.py:490 sphinx/writers/html5.py:449
 msgid "Permalink to this image"
 msgstr ""
 
-#: sphinx/writers/html.py:493 sphinx/writers/html5.py:448
+#: sphinx/writers/html.py:492 sphinx/writers/html5.py:451
 msgid "Permalink to this toctree"
 msgstr ""
 
-#: sphinx/writers/html.py:625 sphinx/writers/html5.py:569
+#: sphinx/writers/html.py:624 sphinx/writers/html5.py:572
 msgid "Could not obtain image size. :scale: option is ignored."
 msgstr ""
 

sphinx/locale/bg/LC_MESSAGES/sphinx.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Sphinx\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2022-01-30 00:11+0000\n"
+"POT-Creation-Date: 2022-02-06 00:13+0000\n"
 "PO-Revision-Date: 2022-01-23 00:11+0000\n"
 "Last-Translator: Komiya Takeshi <i.tkomiya@gmail.com>\n"
 "Language-Team: Bulgarian (http://www.transifex.com/sphinx-doc/sphinx-1/language/bg/)\n"
@@ -2614,7 +2614,7 @@ msgid ""
 "====================== slowest reading durations ======================="
 msgstr ""
 
-#: sphinx/ext/extlinks.py:76
+#: sphinx/ext/extlinks.py:77
 #, python-format
 msgid ""
 "hardcoded link %r could be replaced by an extlink (try using %r instead)"
@@ -3405,19 +3405,19 @@ msgstr ""
 msgid "Other changes"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:199 sphinx/writers/html.py:437
-#: sphinx/writers/html.py:442 sphinx/writers/html5.py:392
-#: sphinx/writers/html5.py:397
+#: sphinx/themes/basic/static/doctools.js:197 sphinx/writers/html.py:436
+#: sphinx/writers/html.py:441 sphinx/writers/html5.py:395
+#: sphinx/writers/html5.py:400
 msgid "Permalink to this headline"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:205 sphinx/writers/html.py:132
-#: sphinx/writers/html.py:141 sphinx/writers/html5.py:107
+#: sphinx/themes/basic/static/doctools.js:203 sphinx/writers/html.py:128
+#: sphinx/writers/html.py:137 sphinx/writers/html5.py:107
 #: sphinx/writers/html5.py:116
 msgid "Permalink to this definition"
 msgstr ""
 
-#: sphinx/themes/basic/static/doctools.js:238
+#: sphinx/themes/basic/static/doctools.js:236
 msgid "Hide Search Matches"
 msgstr ""
 
@@ -3593,37 +3593,37 @@ msgstr ""
 msgid "default role %s not found"
 msgstr ""
 
-#: sphinx/writers/html.py:330 sphinx/writers/html5.py:305
+#: sphinx/writers/html.py:329 sphinx/writers/html5.py:308
 #, python-format
 msgid "numfig_format is not defined for %s"
 msgstr ""
 
-#: sphinx/writers/html.py:340 sphinx/writers/html5.py:315
+#: sphinx/writers/html.py:339 sphinx/writers/html5.py:318
 #, python-format
 msgid "Any IDs not assigned for %s node"
 msgstr ""
 
-#: sphinx/writers/html.py:414 sphinx/writers/html5.py:369
+#: sphinx/writers/html.py:413 sphinx/writers/html5.py:372
 msgid "Permalink to this term"
 msgstr ""
 
-#: sphinx/writers/html.py:446 sphinx/writers/html5.py:401
+#: sphinx/writers/html.py:445 sphinx/writers/html5.py:404
 msgid "Permalink to this table"
 msgstr ""
 
-#: sphinx/writers/html.py:489 sphinx/writers/html5.py:444
+#: sphinx/writers/html.py:488 sphinx/writers/html5.py:447
 msgid "Permalink to this code"
 msgstr ""
 
-#: sphinx/writers/html.py:491 sphinx/writers/html5.py:446
+#: sphinx/writers/html.py:490 sphinx/writers/html5.py:449
 msgid "Permalink to this image"
 msgstr ""
 
-#: sphinx/writers/html.py:493 sphinx/writers/html5.py:448
+#: sphinx/writers/html.py:492 sphinx/writers/html5.py:451
 msgid "Permalink to this toctree"
 msgstr ""
 
-#: sphinx/writers/html.py:625 sphinx/writers/html5.py:569
+#: sphinx/writers/html.py:624 sphinx/writers/html5.py:572
 msgid "Could not obtain image size. :scale: option is ignored."
 msgstr ""
 

sphinx/locale/bn/LC_MESSAGES/sphinx.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Sphinx\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2022-01-30 00:11+0000\n"
+"POT-Creation-Date: 2022-02-06 00:13+0000\n"
 "PO-Revision-Date: 2022-01-23 00:11+0000\n"
 "Last-Translator: Komiya Takeshi <i.tkomiya@gmail.com>\n"
 "Language-Team: Bengali (http://www.transifex.com/sphinx-doc/sphinx-1/language/bn/)\n"
@@ -2615,7 +2615,7 @@ msgid ""
 "====================== slowest reading durations ======================="
 msgstr ""
 
-#: sphinx/ext/extlinks.py:76
+#: sphinx/ext/extlinks.py:77
 #, python-format
 msgid ""
 "hardcoded link %r could be replaced by an extlink (try using %r instead)"
@@ -3406,19 +3406,19 @@ msgstr "C API পরিবর্তন"
 msgid "Other changes"
 msgstr "অন্যান্য পরিবর্তন"
 
-#: sphinx/themes/basic/static/doctools.js:199 sphinx/writers/html.py:437
-#: sphinx/writers/html.py:442 sphinx/writers/html5.py:392
-#: sphinx/writers/html5.py:397
+#: sphinx/themes/basic/static/doctools.js:197 sphinx/writers/html.py:436
+#: sphinx/writers/html.py:441 sphinx/writers/html5.py:395
+#: sphinx/writers/html5.py:400
 msgid "Permalink to this headline"
 msgstr "এই শিরোনামের পার্মালিঙ্ক"
 
-#: sphinx/themes/basic/static/doctools.js:205 sphinx/writers/html.py:132
-#: sphinx/writers/html.py:141 sphinx/writers/html5.py:107
+#: sphinx/themes/basic/static/doctools.js:203 sphinx/writers/html.py:128
+#: sphinx/writers/html.py:137 sphinx/writers/html5.py:107
 #: sphinx/writers/html5.py:116
 msgid "Permalink to this definition"
 msgstr "এই সংজ্ঞার পার্মালিঙ্ক"
 
-#: sphinx/themes/basic/static/doctools.js:238
+#: sphinx/themes/basic/static/doctools.js:236
 msgid "Hide Search Matches"
 msgstr "অনুসন্ধানের ম্যাচগুলো লুকান"
 
@@ -3594,37 +3594,37 @@ msgstr ""
 msgid "default role %s not found"
 msgstr ""
 
-#: sphinx/writers/html.py:330 sphinx/writers/html5.py:305
+#: sphinx/writers/html.py:329 sphinx/writers/html5.py:308
 #, python-format
 msgid "numfig_format is not defined for %s"
 msgstr ""
 
-#: sphinx/writers/html.py:340 sphinx/writers/html5.py:315
+#: sphinx/writers/html.py:339 sphinx/writers/html5.py:318
 #, python-format
 msgid "Any IDs not assigned for %s node"
 msgstr ""
 
-#: sphinx/writers/html.py:414 sphinx/writers/html5.py:369
+#: sphinx/writers/html.py:413 sphinx/writers/html5.py:372
 msgid "Permalink to this term"
 msgstr ""
 
-#: sphinx/writers/html.py:446 sphinx/writers/html5.py:401
+#: sphinx/writers/html.py:445 sphinx/writers/html5.py:404
 msgid "Permalink to this table"
 msgstr ""
 
-#: sphinx/writers/html.py:489 sphinx/writers/html5.py:444
+#: sphinx/writers/html.py:488 sphinx/writers/html5.py:447
 msgid "Permalink to this code"
 msgstr ""
 
-#: sphinx/writers/html.py:491 sphinx/writers/html5.py:446
+#: sphinx/writers/html.py:490 sphinx/writers/html5.py:449
 msgid "Permalink to this image"
 msgstr ""
 
-#: sphinx/writers/html.py:493 sphinx/writers/html5.py:448
+#: sphinx/writers/html.py:492 sphinx/writers/html5.py:451
 msgid "Permalink to this toctree"
 msgstr ""
 
-#: sphinx/writers/html.py:625 sphinx/writers/html5.py:569
+#: sphinx/writers/html.py:624 sphinx/writers/html5.py:572
 msgid "Could not obtain image size. :scale: option is ignored."
 msgstr ""