Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

The intersphinx_mapping in docs/conf.py is incompatible with Sphinx 8 #598

Open
musicinmybrain opened this issue Feb 14, 2025 · 0 comments · May be fixed by #599
Open

The intersphinx_mapping in docs/conf.py is incompatible with Sphinx 8 #598

musicinmybrain opened this issue Feb 14, 2025 · 0 comments · May be fixed by #599

Comments

@musicinmybrain
Copy link

musicinmybrain commented Feb 14, 2025

Description of bug

The format of intersphinx_mapping has changed for Sphinx 8:

https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping

Instead of

intersphinx_mapping = {"https://docs.python.org/3/": None}

we should write

intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

How to reproduce

$ git checkout https://github.com/pallets-eco/flask-caching.git
$ cd flask-caching
$ python3 -m venv _e
$ . _e/bin/activate
(_e) $ pip install -e .
(_e) $ pip install -r requirements/docs.in
(_e) $ make -C docs/ html
make: Entering directory '/home/ben/src/forks/flask-caching/docs'
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v8.1.3
loading translations [en]... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
ERROR: Invalid value `None` in intersphinx_mapping['https://docs.python.org/3/']. Expected a two-element tuple or list.

Configuration error:
Invalid `intersphinx_mapping` configuration (1 error).

Expected behavior:

The documentation should build with Sphinx 8, unblocking #585.

Environment:

  • Python version: Python 3.13.2
  • Flask-Caching version: 494d498

Additional information:

PR to follow.

musicinmybrain added a commit to musicinmybrain/flask-caching that referenced this issue Feb 14, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant