Skip to content

Commit

Permalink
Elaborate comments
Browse files Browse the repository at this point in the history
Also document the build requirements in Doc/using/configure.rst
  • Loading branch information
vstinner committed May 25, 2023
1 parent acc5c47 commit 9d8ff71
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
# By default, highlight as Python 3.
highlight_language = 'python3'

# Minimum version of sphinx required
# Minimum version of sphinx required.
# Sphinx 6.2 no longer uses imghdr which was removed in Python 3.13.
needs_sphinx = '6.2'

# Ignore any .rst files in the includes/ directory;
Expand Down
2 changes: 2 additions & 0 deletions Doc/using/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Features required to build CPython:

* On Windows, Microsoft Visual Studio 2017 or later is required.

* Sphinx 6.2 or newer is required to build the Python documentation.

.. versionchanged:: 3.11
C11 compiler, IEEE 754 and NaN support are now required.
On Windows, Visual Studio 2017 or later is required.
Expand Down
2 changes: 2 additions & 0 deletions Doc/whatsnew/3.13.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,8 @@ Build Changes
=============

* Sphinx 6.2 or newer is now required to build the Python documentation.
Sphinx 6.2 no longer uses the :mod:`!imghdr` module which was removed in
Python 3.13.
(Contributed by Victor Stinner in :gh:`104818`.)


Expand Down

0 comments on commit 9d8ff71

Please sign in to comment.