Merge branch 'master' into fix/napoleon-section-ordering

Author: DavidAGInnovation

CHANGES.rst

@@ -22,6 +22,14 @@ Bugs fixed
 
 * #14189: autodoc: Fix duplicate ``:no-index-entry:`` for modules.
   Patch by Adam Turner
+* #13713: Fix compatibility with MyST-Parser.
+  Patch by Adam Turner
+* Fix tests for Python 3.15.
+  Patch by Adam Turner
+* #14089: autodoc: Fix default option parsing.
+  Patch by Adam Turner
+* Remove incorrect static typing assertions.
+  Patch by Adam Turner
 
 Testing
 -------

sphinx/__init__.py

@@ -11,7 +11,7 @@
 if TYPE_CHECKING:
     from typing import Final
 
-__version__: Final = '9.1.0'
+__version__: Final = '9.1.0rc1'
 __display_version__: Final = __version__  # used for command line version
 
 #: Version info for better programmatic use.
@@ -22,12 +22,12 @@
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info: Final = (9, 1, 0, 'beta', 1)
+version_info: Final = (9, 1, 0, 'candidate', 1)
 
 package_dir: Final = _StrPath(__file__).resolve().parent
 del _StrPath
 
-_in_development = True
+_in_development = False
 if _in_development:
     # Only import subprocess if needed
     import subprocess

sphinx/directives/__init__.py

@@ -215,7 +215,7 @@ def run(self) -> list[Node]:
         # note_source uses 0-based line numbers.
         if line is not None:
             line -= 1
-        self.state.document.note_source(source, line)
+        self.state.document.note_source(source, line)  # type: ignore[arg-type]
         node['domain'] = self.domain
         # 'desctype' is a backwards compatible attribute
         node['objtype'] = node['desctype'] = self.objtype

sphinx/ext/autodoc/_directive_options.py

@@ -275,7 +275,6 @@ def merge_members_option(options: dict[str, Any]) -> None:
     'private-members': members_option,
     'special-members': members_option,
     'member-order': member_order_option,
-    'show-inheritance': bool_option,
 }
 _OPTION_SPEC_MODULE_SPECIFIC: Final[OptionSpec] = {
     'ignore-module-all': bool_option,
@@ -286,6 +285,7 @@ def merge_members_option(options: dict[str, Any]) -> None:
 }
 _OPTION_SPEC_CLASS_SPECIFIC: Final[OptionSpec] = {
     'class-doc-from': class_doc_from_option,
+    'show-inheritance': bool_option,
     'inherited-members': inherited_members_option,
 }
 _OPTION_SPEC_ASSIGNMENT: Final[OptionSpec] = _OPTION_SPEC_COMMON | {
@@ -299,7 +299,9 @@ def merge_members_option(options: dict[str, Any]) -> None:
 _OPTION_SPECS: Final[Mapping[_AutodocObjType, OptionSpec]] = {
     'module': _OPTION_SPEC_HAS_MEMBERS
     | _OPTION_SPEC_MODULE_SPECIFIC
+    | {'show-inheritance': bool_option}  # special case
     | {'inherited-members': inherited_members_option}  # special case
+    | {'no-value': bool_option}  # special case
     | _OPTION_SPEC_DEPRECATED,
     'class': _OPTION_SPEC_HAS_MEMBERS
     | _OPTION_SPEC_CLASS_SPECIFIC

sphinx/ext/autodoc/directive.py

@@ -71,7 +71,7 @@ def __init__(
         env: BuildEnvironment,
         reporter: Reporter | None,
         options: Options,
-        lineno: int,
+        lineno: int | None,
         state: Any,
     ) -> None:
         self.env = env

sphinx/io.py

@@ -32,7 +32,7 @@
 warnings.warn('sphinx.io is deprecated', RemovedInSphinx10Warning, stacklevel=2)
 
 
-class SphinxBaseReader(standalone.Reader['Any']):
+class SphinxBaseReader(standalone.Reader):  # type: ignore[type-arg]
     """A base class of readers for Sphinx.
 
     This replaces reporter by Sphinx's on generating document.

sphinx/util/docutils.py

@@ -12,6 +12,7 @@
 
 import docutils
 import docutils.frontend
+import docutils.writers
 from docutils import nodes
 from docutils.io import FileOutput
 from docutils.parsers.rst import Directive, directives, roles
@@ -499,14 +500,12 @@ def config(self) -> Config:
         """
         return self.env.config
 
-    def get_source_info(self) -> tuple[str, int]:
+    def get_source_info(self) -> tuple[str | None, int | None]:
         """Get source and line number.
 
         .. versionadded:: 3.0
         """
         source, line = self.state_machine.get_source_and_line(self.lineno)
-        assert source is not None
-        assert line is not None
         return source, line
 
     def set_source_info(self, node: Node) -> None:
@@ -680,18 +679,20 @@ def config(self) -> Config:
         """
         return self.env.config
 
-    def get_source_info(self, lineno: int | None = None) -> tuple[str, int]:
+    def get_source_info(
+        self, lineno: int | None = None
+    ) -> tuple[str | os.PathLike[str] | None, int | None]:
         # .. versionadded:: 3.0
         if lineno is None:
             lineno = self.lineno
         source, line = self.inliner.reporter.get_source_and_line(lineno)
-        assert source is not None
-        assert line is not None
-        return str(source), line
+        return source, line
 
     def set_source_info(self, node: Node, lineno: int | None = None) -> None:
         # .. versionadded:: 2.0
-        node.source, node.line = self.get_source_info(lineno)
+        source, line = self.get_source_info(lineno)
+        node.source = str(source) if source is not None else None
+        node.line = line
 
     def get_location(self) -> str:
         """Get current location info for logging.
@@ -879,6 +880,8 @@ def _parse_str_to_doctree(
     transformer.add_transforms(_READER_TRANSFORMS)
     transformer.add_transforms(transforms)
     transformer.add_transforms(parser.get_transforms())
+    # https://github.com/sphinx-doc/sphinx/issues/13713
+    transformer.components['writer'] = _DummyWriter()  # type: ignore[index]
 
     if default_role:
         default_role_cm = rst.default_role(env.current_document.docname, default_role)
@@ -927,6 +930,11 @@ def _get_settings(
     return settings
 
 
+class _DummyWriter(docutils.writers.Writer):  # type: ignore[type-arg]
+    # compat for MyST-Parser
+    supported = ('html',)
+
+
 if docutils.__version_info__[:2] < (0, 22):
     from docutils.parsers.rst import roles
 

tests/test_ext_autosummary/test_ext_autosummary.py

@@ -32,6 +32,12 @@
 if TYPE_CHECKING:
     from xml.etree.ElementTree import Element
 
+if sys.version_info[:2] >= (3, 15):
+    cached_dunder: tuple[str, ...] = ()
+else:
+    cached_dunder = ('__cached__',)
+
+
 html_warnfile = StringIO()
 
 
@@ -268,7 +274,7 @@ def test_autosummary_generate_content_for_module(app):
         '_Exc',
         '__all__',
         '__builtins__',
-        '__cached__',
+        *cached_dunder,
         '__doc__',
         '__file__',
         '__name__',
@@ -377,7 +383,7 @@ def skip_member(app, what, name, obj, skip, options):
         '_Exc',
         '__all__',
         '__builtins__',
-        '__cached__',
+        *cached_dunder,
         '__doc__',
         '__file__',
         '__name__',
@@ -424,7 +430,7 @@ def test_autosummary_generate_content_for_module_imported_members(app):
         '_Exc',
         '__all__',
         '__builtins__',
-        '__cached__',
+        *cached_dunder,
         '__doc__',
         '__file__',
         '__loader__',
@@ -489,7 +495,7 @@ def test_autosummary_generate_content_for_module_imported_members_inherited_modu
         'InheritedAttrClass',
         '__all__',
         '__builtins__',
-        '__cached__',
+        *cached_dunder,
         '__doc__',
         '__file__',
         '__loader__',