Repository navigation
Commit 8d97906
committed
Don't support building documentation on Python 3.8
This discontinues supporting building documentation on Python 3.8.
It does not affect installing or running GitPython on Python 3.8
(except when the `doc` extra is used, but this is only used for
building documentation). The reason is that it is no longer
possible to use the same version of Sphinx on Python 3.8 as on the
most recent supported versions of Python, because Python 3.14 no
longer has `ast.Str` (using `str.Constant` for string literals
instead), which causes the oldest version of `sphinx` that runs on
Python 3.14 to be `sphinx` 7.2.0, while the newest version that is
installable on Python 3.8 is `sphinx` 7.1.2.
The immediately preceding commit changes the requirements for the
`doc` extra to specify a newer `sphinx` version for Python 3.9 and
later. This can't be done on Python 3.8. Because there can be
subtle differences in documentation generated with different
`sphinx` versions, and because Python 3.8 has been end-of-life for
some time, it is not really worth carrying conditional dependencies
for the `sphinx` version in `doc/requirements.txt`.
Note that, while it is probably not a very good idea to use
GitPython (or anything) on Python 3.8 since it is end-of-life, this
change does not stop supporting installing GitPython on that or any
other version it has been supporting. Installing and using
GitPython remains supported all the way back to Python 3.7 at this
time. This only affects the `doc` extra and its requirements.
This change is analogous to the change made in #1956, which
followed up on the change in #1964 in the same way this change
follows up on the change in the immediately preceding commit.1 parent d1ca2af commit 8d97906
2 files changed
Lines changed: 7 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -30,6 +30,11 @@ jobs: | |||
| 30 | 30 | - os-type: ubuntu | |
| 31 | 31 | python-version: "3.7" | |
| 32 | 32 | os-ver: "22.04" | |
| 33 | + - build-docs: true # We ensure documentation builds, except on very old interpreters. | ||
| 34 | + - python-version: "3.7" | ||
| 35 | + build-docs: false | ||
| 36 | + - python-version: "3.8" | ||
| 37 | + build-docs: false | ||
| 33 | 38 | - experimental: false | |
| 34 | 39 | ||
| 35 | 40 | fail-fast: false | |
@@ -110,7 +115,7 @@ jobs: | |||
| 110 | 115 | continue-on-error: false | |
| 111 | 116 | ||
| 112 | 117 | - name: Documentation | |
| 113 | - if: matrix.python-version != '3.7' | ||
| 118 | + if: matrix.build-docs | ||
| 114 | 119 | run: | | |
| 115 | 120 | pip install '.[doc]' | |
| 116 | 121 | make -C doc html | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,3 @@ | |||
| 1 | - sphinx >= 7.4.7, < 8 ; python_version >= "3.9" | ||
| 2 | - sphinx >= 7.1.2, < 7.2 ; python_version < "3.9" | ||
| 1 | + sphinx >= 7.4.7, < 8 | ||
| 3 | 2 | sphinx_rtd_theme | |
| 4 | 3 | sphinx-autodoc-typehints | |
0 commit comments