From Fedora Project Wiki

< Changes

Revision as of 17:37, 6 February 2019 by Churchyard (talk | contribs) (Name and Summary)


Update Sphinx to version 2 and drop Python 2 support from Sphinx

Summary

The version 2.0.x of Sphinx, popular Python documentation generator and framework, is expected to be released in early 2019. It drops support for Python 2. As part of Finalizing Fedora's Switch to Python 3, we update Package-x-generic-16.pngpython-sphinx to 2.0.x and we drop Package-x-generic-16.pngpython2-sphinx and related packages from Fedora 31 and further.

Package maintainers using Sphinx on Python 2 have three options:

  • they stop using Python 2 entirely (preferred), dropping their python2 subpackages if not dependent upon by other packages,
  • they switch to Sphinx on Python 3 for building their documentation,
  • they stop building documentation.

Packages that use Sphinx on Python 2 on runtime are Sphinx extensions, themes etc. and will be removed together with Package-x-generic-16.pngpython2-sphinx.

Owner

  • Name: Your Name
  • Email: <your email address so we can contact you, invite you to meetings, etc.>
  • Release notes owner:

Current status

  • Targeted release: Fedora 31
  • Last updated: 2019-02-06
  • Tracker bug: <will be assigned by the Wrangler>

Detailed Description

Benefit to Fedora

Scope

  • Proposal owners:
  • Other developers: N/A (not a System Wide Change)
  • Policies and guidelines: N/A (not a System Wide Change)
  • Trademark approval: N/A (not needed for this Change)

Upgrade/compatibility impact

N/A (not a System Wide Change)

How To Test

N/A (not a System Wide Change)

User Experience

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: (What to do? Who will do it?) N/A (not a System Wide Change)
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? N/A (not a System Wide Change), Yes/No
  • Blocks product? product

Documentation

N/A (not a System Wide Change)

Release Notes