Bug 1403388 - sphinx obsoletes sphinxcontrib-napoleon, but sphinxcontrib-napoleon is still valid upstream
Summary: sphinx obsoletes sphinxcontrib-napoleon, but sphinxcontrib-napoleon is still ...
Keywords:
Status: CLOSED EOL
Alias: None
Product: Fedora
Classification: Fedora
Component: python-sphinx
Version: 26
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Michel Alexandre Salim
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-12-09 22:33 UTC by Ken Dreyer
Modified: 2018-05-29 11:28 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-05-29 11:28:03 UTC
Type: Bug


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1286275 0 unspecified CLOSED python-sphinxcontrib-napoleon should be retired 2021-02-22 00:41:40 UTC

Internal Links: 1286275

Description Ken Dreyer 2016-12-09 22:33:22 UTC
Description of problem:
Newer versions of Sphinx include the napoleon extension built in. Fedora retired the python-sphinxcontrib-napoleon package in bug 1286275.

However, the napoleon maintainer (Rob Ruana) is still maintaining sphinxcontrib.napoleon and keeping the two codebases in sync: 
https://github.com/evanunderscore/defopt/pull/16

Would you please un-retire python-sphinxcontrib-napoleon?

Version-Release number of selected component (if applicable):
python-sphinx-1.4.8-2.fc26

How reproducible:
always

Steps to Reproduce:
1. In a new package, set "Requires: python-sphinxcontrib-napoleon", or even simply run "dnf install python-sphinxcontrib-napoleon"

Actual results:
DNF installs the main sphinx package, which has several heavyweight dependencies

Expected results:
DNF should install the lightweight python-sphinxcontrib-napoleon package

Additional info:
This is important for packages like defopt, which should be quick to install and have a minimal footprint.

Comment 1 Zbigniew Jędrzejewski-Szmek 2016-12-10 03:05:49 UTC
I originally asked for the sphinxcontrib-napoleon to be retired. Not my package, so my opinion is just that, but frankly, I don't think the justification that sphinx has heavyweight deps is strong enough. Sphinx will usually be used on a development system which has most of dependencies pulled in anyway by other stuff.

Comment 2 Avram Lubkin 2016-12-11 15:29:16 UTC
It seems you want to use sphinxcontrib-napoleon for an "off-label" use, i.e. seems you are using it for it's parsing outside of sphinx. While that is legitimate, it is more of a pocket case. If we did update the spec so python-sphinxcontrib-napoleon was a separate package that didn't require Sphinx, it would cause problems for people who expected Sphinx to be installed as a dependency.

My thought is if upstream intends for the parsers to be used independently of Sphinx, then they should be in an independent Python package which is then required by sphinxcontrib-napoleon.

Comment 3 evanunderscore 2016-12-17 04:13:25 UTC
Starting with version 0.5.0, the sphinxcontrib-napoleon package removed its own dependency on Sphinx to allow people to use its parsing outside of Sphinx. Nevertheless, if the consensus is that the spec should not be changed, I can talk to the maintainer about splitting sphinxcontrib-napoleon into two packages.

Comment 4 Fedora End Of Life 2017-02-28 10:45:51 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 26 development cycle.
Changing version to '26'.

Comment 5 Fedora End Of Life 2018-05-03 08:15:23 UTC
This message is a reminder that Fedora 26 is nearing its end of life.
Approximately 4 (four) weeks from now Fedora will stop maintaining
and issuing updates for Fedora 26. It is Fedora's policy to close all
bug reports from releases that are no longer maintained. At that time
this bug will be closed as EOL if it remains open with a Fedora  'version'
of '26'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version'
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not
able to fix it before Fedora 26 is end of life. If you would still like
to see this bug fixed and are able to reproduce it against a later version
of Fedora, you are encouraged  change the 'version' to a later Fedora
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's
lifetime, sometimes those efforts are overtaken by events. Often a
more recent Fedora release includes newer upstream software that fixes
bugs or makes them obsolete.

Comment 6 Fedora End Of Life 2018-05-29 11:28:03 UTC
Fedora 26 changed to end-of-life (EOL) status on 2018-05-29. Fedora 26
is no longer maintained, which means that it will not receive any
further security or bug fix updates. As a result we are closing this bug.

If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
bug.

Thank you for reporting this bug and we are sorry it could not be fixed.


Note You need to log in before you can comment on or make changes to this bug.