From Fedora Project Wiki
No edit summary
(Add trackers)
 
(11 intermediate revisions by 2 users not shown)
Line 5: Line 5:
Sphinx 4, popular Python documentation generator and framework, has been released in May 2021. It brings many bug fixes, new features including breaking changes and removes long deprecated functions.
Sphinx 4, popular Python documentation generator and framework, has been released in May 2021. It brings many bug fixes, new features including breaking changes and removes long deprecated functions.


In Fedora 35 we will update python-sphinx (incl. python3-sphinx) to the latest version 4.x.
In Fedora 35 we will update [https://src.fedoraproject.org/rpms/python-sphinx python-sphinx] (providing python3-sphinx) to the latest version 4.x.


Package maintainers whose packages will stop building with the Sphinx 4 have these options:
Package maintainers whose packages will stop building with the Sphinx 4 have these options:
Line 11: Line 11:
*  they fix their documentation packages to work with Sphinx 4,
*  they fix their documentation packages to work with Sphinx 4,
*  they stop building documentation subpackages,
*  they stop building documentation subpackages,
*  they create compat package to extend the lifespan of Sphinx 3.x features. Python-maint team can assist with creating the compat package, however we don't like this solution and discourage from doing so.  
*  they create compat package to extend the lifespan of Sphinx 3.x features. Python-maint team can assist with creating the compat package, however we don't like this solution and discourage from doing so.


== Owner ==
== Owner ==
Line 25: Line 25:


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF35]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 43: Line 43:
ON_QA -> change is fully code complete
ON_QA -> change is fully code complete
-->
-->
* FESCo issue: <will be assigned by the Wrangler>
* FESCo issue: [https://pagure.io/fesco/issue/2620 #2620]
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/1973718 #1973718]
* Release notes tracker: <will be assigned by the Wrangler>
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/704 #704]


== Detailed Description ==
== Detailed Description ==
Line 54: Line 54:
* they depend on components which explicitly require older Sphinx versions.
* they depend on components which explicitly require older Sphinx versions.


The change affects these packages (bear in mind, the list may not be complete - some packages which don't build because of the other issues, may be affected also with this change):
The change affects following packages (bear in mind, the list may not be complete - some packages which don't build because of the other issues, may be affected also with this change).


* [https://src.fedoraproject.org/rpms/ansible ansible]
Packages requiring a pinned Sphinx < 4 version on runtime. They will cause a failure of packages that require them:
* [https://src.fedoraproject.org/rpms/ara ara]
 
* [https://src.fedoraproject.org/rpms/arbor arbor]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-click/ python-sphinx-click]
* [https://src.fedoraproject.org/rpms/borgbackup borgbackup]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-phpdomain/ python-sphinxcontrib-phpdomain]
* [https://src.fedoraproject.org/rpms/botan botan]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-myst-parser python-myst-parser]
* [https://src.fedoraproject.org/rpms/buildstream buildstream]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-tabs python-sphinx-tabs]
* [https://src.fedoraproject.org/rpms/condor condor]
 
* [https://src.fedoraproject.org/rpms/copr-keygen copr-keygen]
Packages failing because of the previous group:
* [https://src.fedoraproject.org/rpms/extra-cmake-modules extra-cmake-modules]
 
* [https://src.fedoraproject.org/rpms/gcc gcc]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/buildstream buildstream] - requires python-sphinx-click
* [https://src.fedoraproject.org/rpms/ghc ghc]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/php-opencloud-openstack php-opencloud-openstack] - requires python-sphinxcontrib-phpdomain
* [https://src.fedoraproject.org/rpms/gtksourceview4 gtksourceview4]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/pipenv pipenv] - requires python-sphinx-click
* [https://src.fedoraproject.org/rpms/kea kea]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pip python-pip] - requires python-myst-parser
* [https://src.fedoraproject.org/rpms/krb5 krb5]
 
* [https://src.fedoraproject.org/rpms/libcomps libcomps]
Packages with feature incompatibilities:
* [https://src.fedoraproject.org/rpms/libgpuarray libgpuarray]
 
* [https://src.fedoraproject.org/rpms/llvm llvm]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ansible ansible]
* [https://src.fedoraproject.org/rpms/Mayavi Mayavi]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ara ara]
* [https://src.fedoraproject.org/rpms/paraview paraview]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/arbor arbor]
* [https://src.fedoraproject.org/rpms/php-opencloud-openstack php-opencloud-openstack]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/borgbackup borgbackup]
* [https://src.fedoraproject.org/rpms/pipenv pipenv]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/botan botan]
* [https://src.fedoraproject.org/rpms/pki-core pki-core]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/condor condor]
* [https://src.fedoraproject.org/rpms/py4j py4j]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/copr-keygen copr-keygen]
* [https://src.fedoraproject.org/rpms/python3-docs python3-docs]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/extra-cmake-modules extra-cmake-modules]
* [https://src.fedoraproject.org/rpms/python-anyio python-anyio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/gcc gcc]
* [https://src.fedoraproject.org/rpms/python-breathe python-breathe]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ghc ghc]
* [https://src.fedoraproject.org/rpms/python-BTrees python-BTrees]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/kea kea]
* [https://src.fedoraproject.org/rpms/python-diff-cover python-diff-cover]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/krb5 krb5]
* [https://src.fedoraproject.org/rpms/python-djvulibre python-djvulibre]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/libcomps libcomps]
* [https://src.fedoraproject.org/rpms/python-f5-sdk python-f5-sdk]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/libgpuarray libgpuarray]
* [https://src.fedoraproject.org/rpms/python-flit python-flit]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/Mayavi Mayavi]
* [https://src.fedoraproject.org/rpms/python-glue python-glue]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python3-docs python3-docs]
* [https://src.fedoraproject.org/rpms/python-h2 python-h2]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-anyio python-anyio]
* [https://src.fedoraproject.org/rpms/python-libpysal python-libpysal]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-breathe python-breathe]
* [https://src.fedoraproject.org/rpms/python-listparser python-listparser]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-BTrees python-BTrees]
* [https://src.fedoraproject.org/rpms/python-novaclient python-novaclient]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-djvulibre python-djvulibre]
* [https://src.fedoraproject.org/rpms/python-openstackclient python-openstackclient]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-f5-sdk python-f5-sdk]
* [https://src.fedoraproject.org/rpms/python-patsy python-patsy]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-glue python-glue]
* [https://src.fedoraproject.org/rpms/python-persistent python-persistent]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-h2 python-h2]
* [https://src.fedoraproject.org/rpms/python-pip python-pip]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-libpysal python-libpysal]
* [https://src.fedoraproject.org/rpms/python-pkginfo python-pkginfo]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-listparser python-listparser]
* [https://src.fedoraproject.org/rpms/python-pycryptodomex python-pycryptodomex]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-novaclient python-novaclient]
* [https://src.fedoraproject.org/rpms/python-pynetdicom python-pynetdicom]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-openstackclient python-openstackclient]
* [https://src.fedoraproject.org/rpms/python-pysam python-pysam]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-patsy python-patsy]
* [https://src.fedoraproject.org/rpms/python-pyswarms python-pyswarms]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-persistent python-persistent]
* [https://src.fedoraproject.org/rpms/python-rjsmin python-rjsmin]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pkginfo python-pkginfo]
* [https://src.fedoraproject.org/rpms/python-ruffus python-ruffus]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pycryptodomex python-pycryptodomex]
* [https://src.fedoraproject.org/rpms/python-sphinxcontrib-asyncio python-sphinxcontrib-asyncio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pynetdicom python-pynetdicom]
* [https://src.fedoraproject.org/rpms/python-sphinxcontrib-trio python-sphinxcontrib-trio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pysam python-pysam]
* [https://src.fedoraproject.org/rpms/python-sphinx-notfound-page python-sphinx-notfound-page]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pyswarms python-pyswarms]
* [https://src.fedoraproject.org/rpms/python-texext python-texext]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-rjsmin python-rjsmin]
* [https://src.fedoraproject.org/rpms/python-txtorcon python-txtorcon]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-ruffus python-ruffus]
* [https://src.fedoraproject.org/rpms/python-whoosh python-whoosh]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-asyncio python-sphinxcontrib-asyncio]
* [https://src.fedoraproject.org/rpms/python-zarr python-zarr]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-trio python-sphinxcontrib-trio]
* [https://src.fedoraproject.org/rpms/rebase-helper rebase-helper]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-notfound-page python-sphinx-notfound-page]
* [https://src.fedoraproject.org/rpms/tortoisehg tortoisehg]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-texext python-texext]
* [https://src.fedoraproject.org/rpms/waiverdb waiverdb]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-txtorcon python-txtorcon]
* [https://src.fedoraproject.org/rpms/xeus xeus]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-whoosh python-whoosh]
* [https://src.fedoraproject.org/rpms/xtl xtl]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-zarr python-zarr]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/rebase-helper rebase-helper]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/tortoisehg tortoisehg]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/waiverdb waiverdb]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/xeus xeus]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/xtl xtl]


As said in the summary, packages will either switch to Sphinx 4 or stop building the docs. Change owners can provide guidance and help, yet they cannot be expected to fix all the packages.  
As said in the summary, packages will either switch to Sphinx 4 or stop building the docs. Change owners can provide guidance and help, yet they cannot be expected to fix all the packages.  
Line 125: Line 130:
Proposed timeline:
Proposed timeline:
* 2021-06-01 - 2021-06-25: Package maintainers work on updating the affected packages
* 2021-06-01 - 2021-06-25: Package maintainers work on updating the affected packages
* 2021-06-28: python-sphinx is updated to 4.x in Fedora Rawhide
* 2021-06-28: python-sphinx is updated to the latest 4.x in Fedora Rawhide


The timeline can be affected by the delay of Python3.10 milestone targets. In such case the Sphinx update will be performed on the first possible date.
The timeline can be affected by the delay of Python3.10 milestone targets. In such case the Sphinx update will be performed on the first possible date.

Latest revision as of 14:51, 18 June 2021

Sphinx 4

Summary

Sphinx 4, popular Python documentation generator and framework, has been released in May 2021. It brings many bug fixes, new features including breaking changes and removes long deprecated functions.

In Fedora 35 we will update python-sphinx (providing python3-sphinx) to the latest version 4.x.

Package maintainers whose packages will stop building with the Sphinx 4 have these options:

  • they fix their documentation packages to work with Sphinx 4,
  • they stop building documentation subpackages,
  • they create compat package to extend the lifespan of Sphinx 3.x features. Python-maint team can assist with creating the compat package, however we don't like this solution and discourage from doing so.

Owner

Current status

Detailed Description

Many Fedora packages build-depend on python-sphinx, a popular documentation framework. It was assessed that around 60 packages stop building with the Sphinx 4. The common reasons for failures are:

  • they use long-deprecated functions which have been removed in Sphinx 4,
  • they depend on components which explicitly require older Sphinx versions.

The change affects following packages (bear in mind, the list may not be complete - some packages which don't build because of the other issues, may be affected also with this change).

Packages requiring a pinned Sphinx < 4 version on runtime. They will cause a failure of packages that require them:

Packages failing because of the previous group:

Packages with feature incompatibilities:

As said in the summary, packages will either switch to Sphinx 4 or stop building the docs. Change owners can provide guidance and help, yet they cannot be expected to fix all the packages.

Change timeline

The packages rebuild for planned Python3.10 update is expected in the June 2021. We will do the Sphinx update afterwards.

Proposed timeline:

  • 2021-06-01 - 2021-06-25: Package maintainers work on updating the affected packages
  • 2021-06-28: python-sphinx is updated to the latest 4.x in Fedora Rawhide

The timeline can be affected by the delay of Python3.10 milestone targets. In such case the Sphinx update will be performed on the first possible date.

Benefit to Fedora

Fedora is the leading environment for Python development and will include the newest and greatest Sphinx for users and packagers. They will benefit from its newest functions to build better documentation.

Scope

  • Proposal owners: update python-sphinx to 4.x, provide help
  • Other developers: the update of affected packages can be tested using copr repository where the testing version of Sphinx 4 has been built. (Note: don't worry about the repository name - yes, it's correct).
  • Release engineering: N/A
  • Policies and guidelines: N/A (not needed for this Change)
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Objectives: No

Upgrade/compatibility impact

There is a clean upgrade path from current version to python-sphinx 4. Fedora users using RPM-packaged Sphinx will use Sphinx 4.x by default.

How To Test

  • Find the package you want to update in this copr repository and check the build logs to determine the fail cause. Again, don't worry about the repository name - it's correct.
  • Work with the upstream to resolve the issue or drop the documentation from the package.
  • When updating the package, you can test it using the same copr repository where the latest version of Sphinx 4 has been built.
  • Let us know if something doesn't work as it should.

User Experience

Already covered by sections above.

Dependencies

Already covered in Detailed Description

Contingency Plan

  • Contingency mechanism: (What to do? Who will do it?) Compat package
  • Contingency deadline: Beta freeze
  • Blocks release? No

Documentation

Sphinx changelog

This page is the documentation for Fedora impact.

Release Notes

TBD