From Fedora Project Wiki
(Add trackers)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Update Sphinx to 4.0.x =
= Sphinx 4 =


== Summary ==
== Summary ==


The version 4.0.x of Sphinx, 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.


Package maintainers whose packages will stop building with the Sphinx 4.0.x have these options:
In Fedora 35 we will update [https://src.fedoraproject.org/rpms/python-sphinx python-sphinx] (providing python3-sphinx) to the latest version 4.x.


*  they switch to Sphinx 4.0.x for building their documentation,
Package maintainers whose packages will stop building with the Sphinx 4 have these options:
*  they stop building documentation,
 
*  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 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 ==
== Owner ==
Line 23: 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 41: 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 ==
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
Many Fedora packages build-depend on python-sphinx, a popular documentation framework.  
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.0.2. The common reasons for failures are:
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.0.2,
* they use long-deprecated functions which have been removed in Sphinx 4,
* 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).
 
Packages requiring a pinned Sphinx < 4 version on runtime. They will cause a failure of packages that require them:
 
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-click/ python-sphinx-click]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-phpdomain/ python-sphinxcontrib-phpdomain]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-myst-parser python-myst-parser]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-tabs python-sphinx-tabs]
 
Packages failing because of the previous group:
 
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/buildstream buildstream] - requires python-sphinx-click
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/php-opencloud-openstack php-opencloud-openstack] - requires python-sphinxcontrib-phpdomain
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/pipenv pipenv] - requires python-sphinx-click
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pip python-pip] - requires python-myst-parser
 
Packages with feature incompatibilities:
 
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ansible ansible]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ara ara]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/arbor arbor]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/borgbackup borgbackup]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/botan botan]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/condor condor]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/copr-keygen copr-keygen]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/extra-cmake-modules extra-cmake-modules]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/gcc gcc]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/ghc ghc]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/kea kea]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/krb5 krb5]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/libcomps libcomps]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/libgpuarray libgpuarray]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/Mayavi Mayavi]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python3-docs python3-docs]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-anyio python-anyio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-breathe python-breathe]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-BTrees python-BTrees]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-djvulibre python-djvulibre]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-f5-sdk python-f5-sdk]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-glue python-glue]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-h2 python-h2]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-libpysal python-libpysal]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-listparser python-listparser]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-novaclient python-novaclient]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-openstackclient python-openstackclient]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-patsy python-patsy]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-persistent python-persistent]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pkginfo python-pkginfo]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pycryptodomex python-pycryptodomex]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pynetdicom python-pynetdicom]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pysam python-pysam]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-pyswarms python-pyswarms]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-rjsmin python-rjsmin]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-ruffus python-ruffus]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-asyncio python-sphinxcontrib-asyncio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinxcontrib-trio python-sphinxcontrib-trio]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-sphinx-notfound-page python-sphinx-notfound-page]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-texext python-texext]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-txtorcon python-txtorcon]
* [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/package/python-whoosh python-whoosh]
* [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.
 
=== Change timeline ===
 
The packages rebuild for planned [https://fedoraproject.org/wiki/Changes/Python3.10 Python3.10 update] is expected in the June 2021.
We will do the Sphinx update afterwards.


* [https://src.fedoraproject.org/rpms/ansible ansible]
Proposed timeline:
* [https://src.fedoraproject.org/rpms/ara ara]
* 2021-06-01 - 2021-06-25: Package maintainers work on updating the affected packages
* [https://src.fedoraproject.org/rpms/arbor arbor]
* 2021-06-28: python-sphinx is updated to the latest 4.x in Fedora Rawhide
* [https://src.fedoraproject.org/rpms/borgbackup borgbackup]
* [https://src.fedoraproject.org/rpms/botan botan]
* [https://src.fedoraproject.org/rpms/buildstream buildstream]
* [https://src.fedoraproject.org/rpms/condor condor]
* [https://src.fedoraproject.org/rpms/copr-keygen copr-keygen]
* [https://src.fedoraproject.org/rpms/extra-cmake-modules extra-cmake-modules]
* [https://src.fedoraproject.org/rpms/gcc gcc]
* [https://src.fedoraproject.org/rpms/ghc ghc]
* [https://src.fedoraproject.org/rpms/gtksourceview4 gtksourceview4]
* [https://src.fedoraproject.org/rpms/kea kea]
* [https://src.fedoraproject.org/rpms/krb5 krb5]
* [https://src.fedoraproject.org/rpms/libcomps libcomps]
* [https://src.fedoraproject.org/rpms/libgpuarray libgpuarray]
* [https://src.fedoraproject.org/rpms/llvm llvm]
* [https://src.fedoraproject.org/rpms/Mayavi Mayavi]
* [https://src.fedoraproject.org/rpms/paraview paraview]
* [https://src.fedoraproject.org/rpms/php-opencloud-openstack php-opencloud-openstack]
* [https://src.fedoraproject.org/rpms/pipenv pipenv]
* [https://src.fedoraproject.org/rpms/pki-core pki-core]
* [https://src.fedoraproject.org/rpms/py4j py4j]
* [https://src.fedoraproject.org/rpms/python3-docs python3-docs]
* [https://src.fedoraproject.org/rpms/python-anyio python-anyio]
* [https://src.fedoraproject.org/rpms/python-breathe python-breathe]
* [https://src.fedoraproject.org/rpms/python-BTrees python-BTrees]
* [https://src.fedoraproject.org/rpms/python-diff-cover python-diff-cover]
* [https://src.fedoraproject.org/rpms/python-djvulibre python-djvulibre]
* [https://src.fedoraproject.org/rpms/python-f5-sdk python-f5-sdk]
* [https://src.fedoraproject.org/rpms/python-flit python-flit]
* [https://src.fedoraproject.org/rpms/python-glue python-glue]
* [https://src.fedoraproject.org/rpms/python-h2 python-h2]
* [https://src.fedoraproject.org/rpms/python-libpysal python-libpysal]
* [https://src.fedoraproject.org/rpms/python-listparser python-listparser]
* [https://src.fedoraproject.org/rpms/python-novaclient python-novaclient]
* [https://src.fedoraproject.org/rpms/python-openstackclient python-openstackclient]
* [https://src.fedoraproject.org/rpms/python-patsy python-patsy]
* [https://src.fedoraproject.org/rpms/python-persistent python-persistent]
* [https://src.fedoraproject.org/rpms/python-pip python-pip]
* [https://src.fedoraproject.org/rpms/python-pkginfo python-pkginfo]
* [https://src.fedoraproject.org/rpms/python-pycryptodomex python-pycryptodomex]
* [https://src.fedoraproject.org/rpms/python-pynetdicom python-pynetdicom]
* [https://src.fedoraproject.org/rpms/python-pysam python-pysam]
* [https://src.fedoraproject.org/rpms/python-pyswarms python-pyswarms]
* [https://src.fedoraproject.org/rpms/python-rjsmin python-rjsmin]
* [https://src.fedoraproject.org/rpms/python-ruffus python-ruffus]
* [https://src.fedoraproject.org/rpms/python-sphinxcontrib-asyncio python-sphinxcontrib-asyncio]
* [https://src.fedoraproject.org/rpms/python-sphinxcontrib-trio python-sphinxcontrib-trio]
* [https://src.fedoraproject.org/rpms/python-sphinx-notfound-page python-sphinx-notfound-page]
* [https://src.fedoraproject.org/rpms/python-texext python-texext]
* [https://src.fedoraproject.org/rpms/python-txtorcon python-txtorcon]
* [https://src.fedoraproject.org/rpms/python-whoosh python-whoosh]
* [https://src.fedoraproject.org/rpms/python-zarr python-zarr]
* [https://src.fedoraproject.org/rpms/rebase-helper rebase-helper]
* [https://src.fedoraproject.org/rpms/tortoisehg tortoisehg]
* [https://src.fedoraproject.org/rpms/waiverdb waiverdb]
* [https://src.fedoraproject.org/rpms/xeus xeus]
* [https://src.fedoraproject.org/rpms/xtl xtl]


As said in the summary, packages will either switch to Sphinx 4.0.x or stop building the docs. Change owners can provide guidance and help, yet they cannot be expected to fix all the packages.  
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 ==
== Benefit to Fedora ==
Line 148: Line 166:
-->
-->
== Scope ==
== Scope ==
* Proposal owners: update python-sphinx to 4.0.x, provide help
* Proposal owners: update python-sphinx to 4.x, provide help
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Other developers: the update of affected packages can be tested using [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/ copr repository] where the testing version of Sphinx 4.0.2 has been built.
* Other developers: the update of affected packages can be tested using [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/ copr repository] where the testing version of Sphinx 4 has been built. (Note: don't worry about the repository name - yes, it's correct).
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
Line 170: Line 188:
== Upgrade/compatibility impact ==
== Upgrade/compatibility impact ==


There is a clean upgrade path from current version to 4.0.x.
There is a clean upgrade path from current version to python-sphinx 4.
Fedora users using RPM-packaged Sphinx will use Sphinx 4.0.x by default.
Fedora users using RPM-packaged Sphinx will use Sphinx 4.x by default.
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 192: Line 210:
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->


The update of affected packages can be tested using [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/ copr repository] where the proposed version of Sphinx 4.0.2 has been built.
* Find the package you want to update in this [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/ 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 [https://copr.fedorainfracloud.org/coprs/ksurma/pygments-2.9.0/ 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 ==
== User Experience ==
Line 216: Line 237:


<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency mechanism: (What to do?  Who will do it?) Compat package <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency deadline: Beta freeze <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? No
* Blocks release? No
Line 236: Line 257:
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
-->
-->
N/A
TBD

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