From Fedora Project Wiki
< Changes
Churchyard (talk | contribs) (empty change proposal) |
Churchyard (talk | contribs) (Name and Summary) |
||
| Line 21: | Line 21: | ||
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name. This keeps all change proposals in the same namespace --> | <!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name. This keeps all change proposals in the same namespace --> | ||
= | = Update Sphinx to version 2 and drop Python 2 support from Sphinx <!-- The name of your change proposal --> = | ||
== Summary == | == Summary == | ||
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. | <!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. | ||
Note that motivation for the change should be in the Motivation section below, and this part should answer the question "What?" rather than "Why?". --> | Note that motivation for the change should be in the Motivation section below, and this part should answer the question "What?" rather than "Why?". --> | ||
The version 2.0.x of [https://www.sphinx-doc.org/ Sphinx], popular Python documentation generator and framework, is expected to be [https://github.com/sphinx-doc/sphinx/issues/5950 released in early 2019]. It [https://www.sphinx-doc.org/en/master/changes.html#incompatible-changes drops support for Python 2]. As part of [[FinalizingFedoraSwitchtoPython3|Finalizing Fedora's Switch to Python 3]], we update {{package|python-sphinx}} to 2.0.x and we drop {{package|python2-sphinx}} and related packages from [[Releases/31|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|python2-sphinx}}. | |||
== Owner == | == Owner == | ||
| Line 45: | Line 55: | ||
== Current status == | == Current status == | ||
* Targeted release: [[Releases/ | * Targeted release: [[Releases/31 | Fedora 31 ]] | ||
* Last updated: <!-- this is an automatic macro — you don't need to change this line --> {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}} | * Last updated: <!-- this is an automatic macro — you don't need to change this line --> {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}} | ||
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page | <!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page | ||
Revision as of 17:37, 6 February 2019
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 
python-sphinx
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
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)
- Release engineering: #Releng issue number (a check of an impact with Release Engineering is needed)
- List of deliverables: 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)