From Fedora Project Wiki
< Changes
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
= Sphinx 4 | = Sphinx 4 = | ||
== Summary == | == Summary == | ||
Sphinx 4 | 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 | In Fedora 35 we will update python-sphinx (incl. python3-sphinx) to the latest version 4.x. | ||
Package maintainers whose packages will stop building with the Sphinx 4 | 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 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. | ||
| Line 50: | Line 50: | ||
<!-- 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 | 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 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. | ||
| Line 116: | Line 116: | ||
* [https://src.fedoraproject.org/rpms/xtl xtl] | * [https://src.fedoraproject.org/rpms/xtl xtl] | ||
As said in the summary, packages will either switch to Sphinx 4 | 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 === | === Change timeline === | ||
| Line 125: | Line 125: | ||
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 | * 2021-06-28: python-sphinx is updated to 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. | ||
| Line 161: | Line 161: | ||
--> | --> | ||
== Scope == | == Scope == | ||
* Proposal owners: update python-sphinx to 4 | * 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 | * 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 183: | Line 183: | ||
== Upgrade/compatibility impact == | == Upgrade/compatibility impact == | ||
There is a clean upgrade path from current version to 4 | There is a clean upgrade path from current version to python-sphinx 4. | ||
Fedora users using RPM-packaged Sphinx will use Sphinx 4 | 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 207: | Line 207: | ||
* 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. | * 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. | * 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 | * 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. | * Let us know if something doesn't work as it should. | ||
Revision as of 14:19, 1 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 (incl. 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
- Name: Karolina Surma
- Email: ksurma@redhat.com
Current status
- Targeted release: Fedora Linux 35
- Last updated: 2021-06-01
- FESCo issue: <will be assigned by the Wrangler>
- Tracker bug: <will be assigned by the Wrangler>
- Release notes tracker: <will be assigned by the Wrangler>
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 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):
- ansible
- ara
- arbor
- borgbackup
- botan
- buildstream
- condor
- copr-keygen
- extra-cmake-modules
- gcc
- ghc
- gtksourceview4
- kea
- krb5
- libcomps
- libgpuarray
- llvm
- Mayavi
- paraview
- php-opencloud-openstack
- pipenv
- pki-core
- py4j
- python3-docs
- python-anyio
- python-breathe
- python-BTrees
- python-diff-cover
- python-djvulibre
- python-f5-sdk
- python-flit
- python-glue
- python-h2
- python-libpysal
- python-listparser
- python-novaclient
- python-openstackclient
- python-patsy
- python-persistent
- python-pip
- python-pkginfo
- python-pycryptodomex
- python-pynetdicom
- python-pysam
- python-pyswarms
- python-rjsmin
- python-ruffus
- python-sphinxcontrib-asyncio
- python-sphinxcontrib-trio
- python-sphinx-notfound-page
- python-texext
- python-txtorcon
- python-whoosh
- python-zarr
- rebase-helper
- tortoisehg
- waiverdb
- xeus
- 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 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 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
This page is the documentation for Fedora impact.
Release Notes
TBD