8.2.0 release plan

[AA-Turner]

I intend to release Sphinx 8.2.0 soon, perhaps this week (w/c 10 Feb).

8.2.0 will drop support for Python 3.10, per our support policy.

Please let me know if there are any features or bugfixes you would like to have included in the release, or any other matters.

The open items on the 8.2 milestone are:

• Inline text is not parsed in the Python module index #13067
• Parameter types in the JavaScript domain have erroneous brackets #13217
• Remove productionlist hard-coding in translators #13326

A

cc: @sphinx-doc/developers @sphinx-doc/triagers

[picnixz]

I have academic tasks to do for myself, but I've prepared #13328. You can decide to include it into 8.2 or not.

[mgeier]

I'd like the un-deprecation of sphinx.util.import_object to be included, see #13330.

[jfbu]

Only to ping @chrisjsewell to ask if a concomitant MyST-Parser release will be done, due to our #13207, which has already been solved in master branch of MyST-Parser (see executablebooks/MyST-Parser#1010).

[chrisjsewell]

Only to ping @chrisjsewell to ask if a concomitant MyST-Parser release will be done

just released 😉

[chrisjsewell]

This is good to go @AA-Turner #13333

[jfbu]

I am observing a breakage with some project for which we have a toy model which in suitable environment can be used to test make html fast. (as per the environment requirements maybe this is enough (see instructions in French for the main project which is very big though).

pip install    \
      Sphinx              \
      Pillow              \
      sphinx_comments     \
      sphinx_design       \
      sphinxext.opengraph \
      myst_parser         \
      linkify-it-py       \
      sphinx_tippy        \
      sphinx_sitemap      \
      pydata_sphinx_theme \
      sphinx_copybutton   \
      sphinx_togglebutton \
      sphinx_examples     \
      sphinx_last_updated_by_git

The problem seems to be triggered by our commit a56fdad and manifests itself as

$ make html
Running Sphinx v8.2.0+/a56fdad70
loading translations [fr]... done
making output directory... done

Extension error (myst_parser.sphinx_ext.main):
Handler <function create_myst_config at 0x120a299e0> for event 'builder-inited' threw an exception (exception: cannot import name 'bold' from 'sphinx.util.console' (/path/to/sphinx/sphinx/util/console.py))

I hit against that while bisecting so it seems to direct to MyST-Parser ping @chrisjsewell.

But the original error report at Sphinx master c49d925 looked to be triggered by extension sphinx_last_updated_by_git:

Extension error (sphinx_last_updated_by_git)!

Versions
========

* Platform:         darwin; (macOS-10.13.6-x86_64-i386-64bit)
* Python version:   3.12.3 (CPython)
* Sphinx version:   8.2.0+/c49d925b4
* Docutils version: 0.21.2
* Jinja2 version:   3.1.4
* Pygments version: 2.19.1

Last Messages
=============




    getting Git timestamps for source files... [100%]
    .


    sphinx-sitemap: No pages generated for sitemap.xml
    Path to light image logo does not exist: _static/images/svg/logoFAQ-light-theme.svg
    Path to dark image logo does not exist: _static/images/svg/logoFAQ-dark-theme.svg

Loaded Extensions
=================

* sphinx.ext.mathjax (8.2.0+/c49d925b4)
* alabaster (0.7.16)
* sphinxcontrib.applehelp (1.0.8)
* sphinxcontrib.devhelp (1.0.6)
* sphinxcontrib.htmlhelp (2.1.0)
* sphinxcontrib.serializinghtml (1.1.10)
* sphinxcontrib.qthelp (1.0.7)
* sphinx_comments (0.0.3)
* sphinx.ext.todo (8.2.0+/c49d925b4)
* sphinx.ext.extlinks (8.2.0+/c49d925b4)
* sphinx_design (0.6.0)
* sphinxext.opengraph (unknown version)
* myst_parser (4.0.1)
* sphinx_sitemap (2.6.0)
* sphinx_copybutton (0.5.2)
* sphinx_examples (0.0.5)
* sphinx_togglebutton (0.3.2)
* sphinx_last_updated_by_git (0.3.8)
* pydata_sphinx_theme (unknown version)

Traceback
=========

      File "/path/to/sphinx/sphinx/events.py", line 415, in emit
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function _env_updated at 0x117a9ef20> for event 'env-updated' threw an exception (exception: 'bac-a-sable')

I have not looked yet at the full traceback which I can post if needed. I am posting all this here now because I am not confident I can identify the root cause myself.

[jfbu]

Possibly the myst_parser problem was a transient one solved in later commits to our master branch. Both the toy (minimalistic) project and the real (gigantic) one display the same behaviour, I will try to bisect to when first problem with sphinx_last_updated_by_git showed.

[jfbu]

The problem with sphinx_last_updated_by_git is bisected to 22e0f89. Probably ignore the transient myst_parser problem which showed at some earler state of our master branch but does not show now.

[jfbu]

It looks as if simply there is an incompatibility with extension https://github.com/mgeier/sphinx-last-updated-by-git regarding how filenames are handled.

Traceback (most recent call last):
  File "/path/to/sphinx/sphinx/events.py", line 404, in emit
    results.append(listener.handler(self.app, *args))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/faq-gut/.venv/lib/python3.12/site-packages/sphinx_last_updated_by_git.py", line 187, in _env_updated
    for dep in env.dependencies[docname]:
               ~~~~~~~~~~~~~~~~^^^^^^^^^
KeyError: '2_programmation/erreurs/i/start'

WIll try to create some more minimal example and ping @mgeier at the extension issue handler.

Sorry for noise of previous messages I should have waited until I had a minimal example, but the original project is so enormous I was not sure I could do this quick. I have opened an issue at mgeier/sphinx-last-updated-by-git#79.