[PATCH v2 0/2] docs/python: bump minimum Sphinx version

John Snow posted 2 patches 5 months, 3 weeks ago
docs/conf.py             |  7 +++----
docs/sphinx/hxtool.py    | 21 ++++-----------------
docs/sphinx/kerneldoc.py | 38 ++++++++++++--------------------------
docs/sphinx/kernellog.py | 28 ----------------------------
docs/sphinx/qapidoc.py   | 29 +++--------------------------
pythondeps.toml          |  2 +-
6 files changed, 23 insertions(+), 102 deletions(-)
delete mode 100644 docs/sphinx/kernellog.py
[PATCH v2 0/2] docs/python: bump minimum Sphinx version
Posted by John Snow 5 months, 3 weeks ago
With recent deprecations, we can advance our minimum sphinx version
safely. This is heavily motivated by new qapidoc work which is much
easier to maintain cross-version compatibility for - see difficulties in
our dbus documentation which only works on sphinx >= 4.

We can only guarantee >= 3.4.3 now, but that's still vastly easier than
maintaining compatibility all the way back to 1.x.

https://gitlab.com/jsnow/qemu/-/pipelines/1359549621

(failures appear to be unrelated to the series.)

V2: refactor all code deletions into patch 2

John Snow (2):
  Python: bump minimum sphinx version to 3.4.3
  docs: remove Sphinx 1.x compatibility code

 docs/conf.py             |  7 +++----
 docs/sphinx/hxtool.py    | 21 ++++-----------------
 docs/sphinx/kerneldoc.py | 38 ++++++++++++--------------------------
 docs/sphinx/kernellog.py | 28 ----------------------------
 docs/sphinx/qapidoc.py   | 29 +++--------------------------
 pythondeps.toml          |  2 +-
 6 files changed, 23 insertions(+), 102 deletions(-)
 delete mode 100644 docs/sphinx/kernellog.py

-- 
2.45.0

Re: [PATCH v2 0/2] docs/python: bump minimum Sphinx version
Posted by John Snow 5 months, 3 weeks ago
On Wed, Jul 3, 2024, 1:52 PM John Snow <jsnow@redhat.com> wrote:

> With recent deprecations, we can advance our minimum sphinx version
> safely. This is heavily motivated by new qapidoc work which is much
> easier to maintain cross-version compatibility for - see difficulties in
> our dbus documentation which only works on sphinx >= 4.
>
> We can only guarantee >= 3.4.3 now, but that's still vastly easier than
> maintaining compatibility all the way back to 1.x.
>
> https://gitlab.com/jsnow/qemu/-/pipelines/1359549621
>
> (failures appear to be unrelated to the series.)
>
> V2: refactor all code deletions into patch 2
>
> John Snow (2):
>   Python: bump minimum sphinx version to 3.4.3
>   docs: remove Sphinx 1.x compatibility code
>
>  docs/conf.py             |  7 +++----
>  docs/sphinx/hxtool.py    | 21 ++++-----------------
>  docs/sphinx/kerneldoc.py | 38 ++++++++++++--------------------------
>  docs/sphinx/kernellog.py | 28 ----------------------------
>  docs/sphinx/qapidoc.py   | 29 +++--------------------------
>  pythondeps.toml          |  2 +-
>  6 files changed, 23 insertions(+), 102 deletions(-)
>  delete mode 100644 docs/sphinx/kernellog.py
>
> --
> 2.45.0
>

Going to assume It's okay for me to stage this one under my Python tree.

Markus: This will create a minor conflict with the notes patches (the
delint patch), but the resolution is straightforward.

--js