Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

ERROR: Invalid value None in intersphinx_mapping['http://docs.python.org/']. Expected a two-element tuple or list. #191

Open
florianernst opened this issue Dec 30, 2024 · 0 comments

Comments

@florianernst
Copy link

Hello everyone,

the documentation fails to build with Sphinx 8 due to intersphinx_mapping now being structured differently, cf. intersphinx_mapping documentation.

With the current value a build fails along the lines of

Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
ERROR: Invalid value `None` in intersphinx_mapping['http://docs.python.org/']. Expected a two-element tuple or list.

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

whereas a tiny adjustment like

--- pyte-0.8.0.orig/docs/conf.py
+++ pyte-0.8.0/docs/conf.py
@@ -176,7 +176,7 @@ else:
 htmlhelp_basename = 'pytedoc'

 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

 autodoc_member_order = 'bysource'
 todo_include_todos = True

allows the documentation to build again with Sphinx 8.

Yes, the above diff references pyte-0.8.0, but the current version at https://github.com/selectel/pyte/blob/master/docs/conf.py#L215 looks just the same.

HTH,
Flo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant