Merge remote-tracking branch 'origin/master' into new-inline-parse-i18n-logic

Author: n-peugnet

.ruff.toml

@@ -386,6 +386,9 @@ select = [
 # from .flake8
 "sphinx/*" = ["E241"]
 
+# whitelist ``print`` for stdout messages
+"sphinx/_cli/__init__.py" = ["T201"]
+
 # whitelist ``print`` for stdout messages
 "sphinx/cmd/build.py" = ["T201"]
 "sphinx/cmd/make_mode.py" = ["T201"]
@@ -435,282 +438,36 @@ forced-separate = [
 preview = true
 quote-style = "single"
 exclude = [
+    "sphinx/_cli/*",
     "sphinx/addnodes.py",
     "sphinx/application.py",
-    "sphinx/builders/gettext.py",
-    "sphinx/builders/text.py",
-    "sphinx/builders/linkcheck.py",
-    "sphinx/builders/_epub_base.py",
-    "sphinx/builders/dummy.py",
-    "sphinx/builders/changes.py",
-    "sphinx/builders/texinfo.py",
-    "sphinx/builders/dirhtml.py",
-    "sphinx/builders/__init__.py",
-    "sphinx/builders/xml.py",
-    "sphinx/builders/singlehtml.py",
-    "sphinx/builders/epub3.py",
-    "sphinx/builders/manpage.py",
-    "sphinx/builders/latex/constants.py",
-    "sphinx/builders/latex/__init__.py",
-    "sphinx/builders/latex/theming.py",
-    "sphinx/builders/latex/transforms.py",
-    "sphinx/builders/latex/util.py",
-    "sphinx/builders/latex/nodes.py",
-    "sphinx/builders/html/_assets.py",
-    "sphinx/builders/html/__init__.py",
-    "sphinx/builders/html/transforms.py",
-    "sphinx/cmd/quickstart.py",
-    "sphinx/cmd/build.py",
-    "sphinx/cmd/make_mode.py",
+    "sphinx/builders/*",
+    "sphinx/cmd/*",
     "sphinx/config.py",
-    "sphinx/directives/__init__.py",
-    "sphinx/directives/code.py",
-    "sphinx/directives/patches.py",
-    "sphinx/directives/other.py",
-    "sphinx/domains/math.py",
-    "sphinx/domains/changeset.py",
-    "sphinx/domains/javascript.py",
-    "sphinx/domains/__init__.py",
-    "sphinx/domains/citation.py",
-    "sphinx/domains/rst.py",
-    "sphinx/domains/index.py",
-    "sphinx/domains/std/__init__.py",
-    "sphinx/domains/python/_annotations.py",
-    "sphinx/domains/python/__init__.py",
-    "sphinx/domains/python/_object.py",
-    "sphinx/domains/cpp/_parser.py",
-    "sphinx/domains/cpp/_ids.py",
-    "sphinx/domains/cpp/__init__.py",
-    "sphinx/domains/cpp/_symbol.py",
-    "sphinx/domains/cpp/_ast.py",
-    "sphinx/domains/c/_parser.py",
-    "sphinx/domains/c/_ids.py",
-    "sphinx/domains/c/__init__.py",
-    "sphinx/domains/c/_symbol.py",
-    "sphinx/domains/c/_ast.py",
-    "sphinx/environment/__init__.py",
-    "sphinx/environment/collectors/dependencies.py",
-    "sphinx/environment/collectors/toctree.py",
-    "sphinx/environment/collectors/metadata.py",
-    "sphinx/environment/collectors/title.py",
-    "sphinx/environment/collectors/asset.py",
-    "sphinx/environment/collectors/__init__.py",
-    "sphinx/environment/adapters/toctree.py",
-    "sphinx/environment/adapters/indexentries.py",
-    "sphinx/environment/adapters/asset.py",
-    "sphinx/ext/extlinks.py",
-    "sphinx/ext/todo.py",
-    "sphinx/ext/mathjax.py",
-    "sphinx/ext/doctest.py",
-    "sphinx/ext/autosectionlabel.py",
-    "sphinx/ext/intersphinx/__init__.py",
-    "sphinx/ext/intersphinx/_cli.py",
-    "sphinx/ext/intersphinx/_load.py",
-    "sphinx/ext/intersphinx/_resolve.py",
-    "sphinx/ext/duration.py",
-    "sphinx/ext/imgconverter.py",
-    "sphinx/ext/imgmath.py",
-    "sphinx/ext/apidoc.py",
-    "sphinx/ext/viewcode.py",
-    "sphinx/ext/githubpages.py",
-    "sphinx/ext/linkcode.py",
-    "sphinx/ext/ifconfig.py",
-    "sphinx/ext/inheritance_diagram.py",
-    "sphinx/ext/coverage.py",
-    "sphinx/ext/graphviz.py",
-    "sphinx/ext/napoleon/docstring.py",
-    "sphinx/ext/napoleon/__init__.py",
-    "sphinx/ext/autodoc/typehints.py",
-    "sphinx/ext/autodoc/preserve_defaults.py",
-    "sphinx/ext/autodoc/__init__.py",
-    "sphinx/ext/autodoc/directive.py",
-    "sphinx/ext/autodoc/importer.py",
-    "sphinx/ext/autodoc/type_comment.py",
-    "sphinx/ext/autodoc/mock.py",
-    "sphinx/ext/autosummary/__init__.py",
-    "sphinx/ext/autosummary/generate.py",
-    "sphinx/pycode/ast.py",
-    "sphinx/pycode/__init__.py",
-    "sphinx/pycode/parser.py",
+    "sphinx/directives/*",
+    "sphinx/domains/*",
+    "sphinx/environment/*",
+    "sphinx/ext/*",
+    "sphinx/pycode/*",
     "sphinx/pygments_styles.py",
     "sphinx/registry.py",
-    "sphinx/search/*.py",
-    "sphinx/testing/fixtures.py",
-    "sphinx/testing/path.py",
-    "sphinx/testing/restructuredtext.py",
-    "sphinx/testing/util.py",
-    "sphinx/transforms/__init__.py",
-    "sphinx/transforms/compact_bullet_list.py",
-    "sphinx/transforms/references.py",
-    "sphinx/transforms/i18n.py",
-    "sphinx/transforms/post_transforms/__init__.py",
-    "sphinx/transforms/post_transforms/code.py",
-    "sphinx/transforms/post_transforms/images.py",
-    "sphinx/util/build_phase.py",
-    "sphinx/util/template.py",
-    "sphinx/util/osutil.py",
-    "sphinx/util/docutils.py",
-    "sphinx/util/_pathlib.py",
-    "sphinx/util/cfamily.py",
-    "sphinx/util/math.py",
-    "sphinx/util/logging.py",
-    "sphinx/util/inspect.py",
-    "sphinx/util/parallel.py",
-    "sphinx/util/inventory.py",
-    "sphinx/util/__init__.py",
-    "sphinx/util/docfields.py",
-    "sphinx/util/display.py",
-    "sphinx/util/http_date.py",
-    "sphinx/util/matching.py",
-    "sphinx/util/index_entries.py",
-    "sphinx/util/typing.py",
-    "sphinx/util/images.py",
-    "sphinx/util/exceptions.py",
-    "sphinx/util/requests.py",
-    "sphinx/util/docstrings.py",
-    "sphinx/util/rst.py",
-    "sphinx/util/i18n.py",
-    "sphinx/util/fileutil.py",
-    "sphinx/util/png.py",
-    "sphinx/util/tags.py",
-    "sphinx/util/texescape.py",
-    "sphinx/util/nodes.py",
-    "sphinx/util/_io.py",
-    "sphinx/writers/text.py",
-    "sphinx/writers/html5.py",
-    "sphinx/writers/html.py",
-    "sphinx/writers/texinfo.py",
-    "sphinx/writers/latex.py",
-    "sphinx/writers/xml.py",
-    "sphinx/writers/manpage.py",
-    "tests/conftest.py",
-    "tests/roots/**/*",
-    "tests/test_addnodes.py",
-    "tests/test_application.py",
-    "tests/test_builders/test_build_html_maths.py",
-    "tests/test_builders/test_build_html_image.py",
-    "tests/test_builders/test_build_latex.py",
-    "tests/test_builders/test_build_text.py",
-    "tests/test_builders/test_build_html_5_output.py",
-    "tests/test_builders/test_build_changes.py",
-    "tests/test_builders/test_builder.py",
-    "tests/test_builders/test_build_html_tocdepth.py",
-    "tests/test_builders/test_build_html_download.py",
-    "tests/test_builders/test_build_dirhtml.py",
-    "tests/test_builders/test_build_warnings.py",
-    "tests/test_builders/test_build_html_assets.py",
-    "tests/test_builders/test_build_html.py",
-    "tests/test_builders/test_build_linkcheck.py",
-    "tests/test_builders/test_build_manpage.py",
-    "tests/test_builders/xpath_data.py",
-    "tests/test_builders/test_build_html_highlight.py",
-    "tests/test_builders/test_build_epub.py",
-    "tests/test_builders/test_build_html_code.py",
-    "tests/test_builders/test_build_texinfo.py",
-    "tests/test_builders/xpath_util.py",
-    "tests/test_builders/test_build_gettext.py",
-    "tests/test_builders/conftest.py",
-    "tests/test_builders/test_build_html_numfig.py",
-    "tests/test_builders/test_build.py",
-    "tests/test_config/test_correct_year.py",
-    "tests/test_config/test_config.py",
-    "tests/test_directives/test_directive_patch.py",
-    "tests/test_directives/test_directive_code.py",
-    "tests/test_directives/test_directive_other.py",
-    "tests/test_directives/test_directive_option.py",
-    "tests/test_directives/test_directive_object_description.py",
-    "tests/test_directives/test_directive_only.py",
-    "tests/test_directives/test_directives_no_typesetting.py",
-    "tests/test_domains/test_domain_rst.py",
-    "tests/test_domains/test_domain_py_pyobject.py",
-    "tests/test_domains/test_domain_cpp.py",
-    "tests/test_domains/test_domain_py_canonical.py",
-    "tests/test_domains/test_domain_js.py",
-    "tests/test_domains/test_domain_c.py",
-    "tests/test_domains/test_domain_py_fields.py",
-    "tests/test_domains/test_domain_py.py",
-    "tests/test_domains/test_domain_std.py",
-    "tests/test_domains/test_domain_py_pyfunction.py",
-    "tests/test_environment/test_environment_indexentries.py",
-    "tests/test_environment/test_environment_record_dependencies.py",
-    "tests/test_environment/test_environment_toctree.py",
-    "tests/test_environment/test_environment.py",
-    "tests/test_errors.py",
-    "tests/test_events.py",
-    "tests/test_extensions/test_ext_doctest.py",
-    "tests/test_extensions/test_extension.py",
-    "tests/test_extensions/test_ext_imgconverter.py",
-    "tests/test_extensions/test_ext_graphviz.py",
-    "tests/test_extensions/test_ext_apidoc.py",
-    "tests/test_extensions/test_ext_autodoc.py",
-    "tests/test_extensions/test_ext_todo.py",
-    "tests/test_extensions/autodoc_util.py",
-    "tests/test_extensions/test_ext_extlinks.py",
-    "tests/test_extensions/test_ext_autodoc_events.py",
-    "tests/test_extensions/test_ext_githubpages.py",
-    "tests/test_extensions/test_ext_intersphinx.py",
-    "tests/test_extensions/test_ext_napoleon.py",
-    "tests/test_extensions/test_ext_coverage.py",
-    "tests/test_extensions/ext_napoleon_pep526_data_numpy.py",
-    "tests/test_extensions/test_ext_autodoc_configs.py",
-    "tests/test_extensions/test_ext_viewcode.py",
-    "tests/test_extensions/test_ext_autodoc_preserve_defaults.py",
-    "tests/test_extensions/test_ext_autodoc_mock.py",
-    "tests/test_extensions/test_ext_autodoc_autoclass.py",
-    "tests/test_extensions/test_ext_imgmockconverter.py",
-    "tests/test_extensions/test_ext_autodoc_autoattribute.py",
-    "tests/test_extensions/test_ext_ifconfig.py",
-    "tests/test_extensions/test_ext_autodoc_autofunction.py",
-    "tests/test_extensions/ext_napoleon_pep526_data_google.py",
-    "tests/test_extensions/test_ext_duration.py",
-    "tests/test_extensions/test_ext_autodoc_autoproperty.py",
-    "tests/test_extensions/test_ext_autosummary.py",
-    "tests/test_extensions/test_ext_autosectionlabel.py",
-    "tests/test_extensions/test_ext_napoleon_docstring.py",
-    "tests/test_extensions/test_ext_autodoc_automodule.py",
-    "tests/test_extensions/test_ext_autodoc_private_members.py",
-    "tests/test_extensions/test_ext_math.py",
-    "tests/test_extensions/test_ext_autodoc_autodata.py",
-    "tests/test_extensions/test_ext_inheritance_diagram.py",
-    "tests/test_highlighting.py",
-    "tests/test_intl/test_catalogs.py",
-    "tests/test_intl/test_intl.py",
-    "tests/test_intl/test_locale.py",
-    "tests/test_markup/test_smartquotes.py",
-    "tests/test_markup/test_markup.py",
-    "tests/test_markup/test_parser.py",
-    "tests/test_markup/test_metadata.py",
-    "tests/test_project.py",
-    "tests/test_pycode/test_pycode_parser.py",
-    "tests/test_pycode/test_pycode_ast.py",
-    "tests/test_pycode/test_pycode.py",
-    "tests/test_quickstart.py",
-    "tests/test_roles.py",
-    "tests/test_search.py",
-    "tests/test_toctree.py",
-    "tests/test_transforms/test_transforms_reorder_nodes.py",
-    "tests/test_transforms/test_transforms_move_module_targets.py",
-    "tests/test_transforms/test_transforms_post_transforms_code.py",
-    "tests/test_transforms/test_transforms_post_transforms.py",
-    "tests/test_util/test_util_display.py",
-    "tests/test_util/test_util_inventory.py",
-    "tests/test_util/intersphinx_data.py",
-    "tests/test_util/test_util_logging.py",
-    "tests/test_util/test_util_matching.py",
-    "tests/test_util/test_util_typing.py",
-    "tests/test_util/test_util_fileutil.py",
-    "tests/test_util/test_util_template.py",
-    "tests/test_util/test_util_docstrings.py",
-    "tests/test_util/test_util_images.py",
-    "tests/test_util/test_util.py",
-    "tests/test_util/test_util_nodes.py",
-    "tests/test_util/test_util_i18n.py",
-    "tests/test_util/test_util_rst.py",
-    "tests/test_util/typing_test_data.py",
-    "tests/test_util/test_util_docutils.py",
-    "tests/test_util/test_util_inspect.py",
-    "tests/test_versioning.py",
-    "tests/test_writers/test_api_translator.py",
-    "tests/test_writers/test_docutilsconf.py",
-    "tests/test_writers/test_writer_latex.py",
+    "sphinx/search/*",
+    "sphinx/testing/*",
+    "sphinx/transforms/*",
+    "sphinx/util/*",
+    "sphinx/writers/*",
+    "tests/*",
+    "tests/roots/*",
+    "tests/test_builders/*",
+    "tests/test_config/*",
+    "tests/test_directives/*",
+    "tests/test_domains/*",
+    "tests/test_environment/*",
+    "tests/test_extensions/*",
+    "tests/test_intl/*",
+    "tests/test_markup/*",
+    "tests/test_pycode/*",
+    "tests/test_transforms/*",
+    "tests/test_util/*",
+    "tests/test_writers/*",
 ]

CHANGES.rst

@@ -22,9 +22,14 @@ Features added
   when turning annotations into strings.
   Patch by Adam Turner.
 
+* #12319: ``sphinx.ext.extlinks``: Add ``extlink-{name}`` CSS class to links.
+  Patch by Hugo van Kemenade.
+
 Bugs fixed
 ----------
 
+* #12314: Properly format ``collections.abc.Callable`` in annotations.
+  Patch by Adam Turner.
 * #12162: Fix a performance regression in the C domain that has
   been present since version 3.0.0.
   Patch by Donald Hunter.
@@ -34,6 +39,9 @@ Bugs fixed
   Patch by Matthias Geier.
 * #12224: Properly detect WebP files.
   Patch by Benjamin Cabé.
+* #12380: LaTeX: Footnote mark sometimes indicates ``Page N`` where ``N`` is
+  the current page number and the footnote does appear on that same page.
+  Patch by Jean-François B.
 
 Testing
 -------

EXAMPLES.rst

@@ -28,6 +28,7 @@ Documentation using the alabaster theme
 * `Invoke <https://docs.pyinvoke.org/>`__
 * `Jinja <https://jinja.palletsprojects.com/>`__
 * `Lino <https://www.lino-framework.org/>`__ (customized)
+* `Linux kernel <https://www.kernel.org/doc/html/latest/index.html>`__ (customized)
 * `marbl <https://getmarbl.readthedocs.io/>`__
 * `MeshPy <https://documen.tician.de/meshpy/>`__
 * `Molecule <https://molecule.readthedocs.io/>`__
@@ -214,7 +215,6 @@ Documentation using sphinx_rtd_theme
 * `Learning Apache Spark with Python <https://runawayhorse001.github.io/LearningApacheSpark>`__
 * `LibCEED <https://libceed.readthedocs.io/>`__
 * `Linguistica <https://linguistica-uchicago.github.io/lxa5/>`__
-* `Linux kernel <https://www.kernel.org/doc/html/latest/index.html>`__
 * `Mailman <https://docs.list.org/>`__
 * `MathJax <https://docs.mathjax.org/>`__
 * `MDTraj <https://mdtraj.org/>`__ (customized)

doc/development/tutorials/examples/recipe.py

@@ -122,6 +122,7 @@ class RecipeDomain(Domain):
         'recipes': [],  # object list
         'recipe_ingredients': {},  # name -> object
     }
+    data_version = 0
 
     def get_full_qualified_name(self, node):
         return f'recipe.{node.arguments[0]}'

doc/development/tutorials/examples/todo.py

@@ -132,6 +132,7 @@ def setup(app: Sphinx) -> ExtensionMetadata:
 
     return {
         'version': '0.1',
+        'env_version': 1,
         'parallel_read_safe': True,
         'parallel_write_safe': True,
     }

doc/internals/contributing.rst

@@ -156,7 +156,7 @@ Please follow these guidelines when writing code for Sphinx:
 
 Style and type checks can be run as follows::
 
-    ruff .
+    ruff check .
     mypy sphinx/
 
 Unit tests

doc/man/sphinx-build.rst

@@ -126,7 +126,7 @@ Options
    Distribute the build over *N* processes in parallel, to make building on
    multiprocessor machines more effective.  Note that not all parts and not all
    builders of Sphinx can be parallelized.  If ``auto`` argument is given,
-   Sphinx uses the number of CPUs as *N*.
+   Sphinx uses the number of CPUs as *N*. Defaults to 1.
 
    .. versionadded:: 1.2
       This option should be considered *experimental*.