Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
Source: xapian-bindings Severity: important Hello, from what i can see, xapian-bindings builds its documentation twice, one for the python2 bindings (and install that in bin:python-xapian) and one for the python3 bindings (and install that in bin:python3-xapian). this is usually un-necessary, and the convention is to create a separate package to contain the documentation, in this case python-xapian-doc. So please split out such a package to contain the documentation for the python bindings in a single place, and that the same time, please only use python3-sphinx to build the documentation. This will help us in reducing the reverse dependencies of bin:python-sphinx, so that we can introduce a python3-only sphinx version in unstable. Thanks, Sandro -- System Information: Debian Release: 10.0 APT prefers unstable-debug APT policy: (500, 'unstable-debug'), (500, 'unstable'), (1, 'experimental-debug'), (1, 'experimental') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 4.19.0-5-amd64 (SMP w/8 CPU cores) Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE= (charmap=UTF-8) Shell: /bin/sh linked to /bin/dash Init: systemd (via /run/systemd/system) LSM: AppArmor: enabled
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
Control: tags -1 wontfix On Sat, Mar 14, 2020 at 05:35:14PM -0400, Sandro Tosi wrote: > from what i can see, xapian-bindings builds its documentation twice, one for > the > python2 bindings (and install that in bin:python-xapian) and one for the > python3 > bindings (and install that in bin:python3-xapian). > > this is usually un-necessary, and the convention is to create a separate > package > to contain the documentation, in this case python-xapian-doc. So please split > out such a package to contain the documentation for the python bindings in a > single place, and that the same time, please only use python3-sphinx to build > the documentation. The Python2 and Python3 bindings don't have exactly the same API (mostly due to Unicode handling differences, but also the Python3 bindings don't include various backward-compatibility features with older versions of the Python2 bindings) A single set of docs doesn't really work as the Python3 bindings docs aren't a good replacement for the Python2 bindings docs. It this seems to fall outside your "usually un-necessary" hence tagging as wontfix. Cheers, Olly
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
> The Python2 and Python3 bindings don't have exactly the same API (mostly > due to Unicode handling differences, but also the Python3 bindings don't > include various backward-compatibility features with older versions of > the Python2 bindings) does the documentation access the bindings source code at build time? if not, you can still use only python3-sphinx to build both doc versions (and still ship them separately). -- Sandro "morph" Tosi My website: http://sandrotosi.me/ Me at Debian: http://wiki.debian.org/SandroTosi Twitter: https://twitter.com/sandrotosi
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
On Sat, Mar 14, 2020 at 05:59:42PM -0400, Sandro Tosi wrote: > > The Python2 and Python3 bindings don't have exactly the same API (mostly > > due to Unicode handling differences, but also the Python3 bindings don't > > include various backward-compatibility features with older versions of > > the Python2 bindings) > > does the documentation access the bindings source code at build time? > if not, you can still use only python3-sphinx to build both doc > versions (and still ship them separately). It does - that's why it requires both versions of sphinx rather than just running allowing one to be specified. Cheers, Olly
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
On Sat, Mar 14, 2020 at 05:35:14PM -0400, Sandro Tosi wrote: > This will help us in reducing the reverse dependencies of > bin:python-sphinx, so that we can introduce a python3-only sphinx > version in unstable. Having pondered, I'd suggest we just leave xapian-bindings as-is until you're at the point of dropping python2 support from sphinx and then I'll drop the sphinx-generated docs for the python2 bindings from the Debian package entirely. If anyone still wants to look at them they are at least available online. And maybe we'll be ready to remove the python2 bindings before then anyway (there weren't very many rdeps left last time I looked). Cheers, Olly
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
> And maybe we'll be ready to remove the python2 bindings before then > anyway (there weren't very many rdeps left last time I looked). i'm afraid that wont happen that easily: python-xapian is keep in transitively by python-moinmoin (which we use for wiki.d.o) and its port to python3 is no where near being completed :( -- Sandro "morph" Tosi My website: http://sandrotosi.me/ Me at Debian: http://wiki.debian.org/SandroTosi Twitter: https://twitter.com/sandrotosi
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
> Having pondered, I'd suggest we just leave xapian-bindings as-is > until you're at the point of dropping python2 support from sphinx and > then I'll drop the sphinx-generated docs for the python2 bindings > from the Debian package entirely. we're finally in the single digit number of reverse dependencies for python-sphinx and i'd like to aggressively removing all the remaining rdeps. could you please upload xapian-bindings with the python2 bindings documentation removed (including the b-d on python-sphinx)? that would help a lot Cheers, -- Sandro "morph" Tosi My website: http://sandrotosi.me/ Me at Debian: http://wiki.debian.org/SandroTosi Twitter: https://twitter.com/sandrotosi
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
On Sat, Mar 21, 2020 at 06:12:48PM -0400, Sandro Tosi wrote: > > Having pondered, I'd suggest we just leave xapian-bindings as-is > > until you're at the point of dropping python2 support from sphinx and > > then I'll drop the sphinx-generated docs for the python2 bindings > > from the Debian package entirely. > > we're finally in the single digit number of reverse dependencies for > python-sphinx Are you sure? dak rm thinks: Checking reverse dependencies... # Broken Depends: funkload: funkload-doc sphinx-patchqueue: python-sphinx-patchqueue # Broken Build-Depends: brian: python-sphinx dh-virtualenv: python-sphinx dipy: python-sphinx (>= 1.0) django-ratelimit: python-sphinx funkload: python-sphinx ganeti: python-sphinx (>= 1.0.7+dfsg) ghc: python-sphinx iptables-converter: python-sphinx iptables-optimizer: python-sphinx (>= 1.2.3) krb5: python-sphinx llvm-toolchain-6.0: python-sphinx llvm-toolchain-7: python-sphinx (>= 1.3.6) mini-buildd: python-sphinx (>= 1.1.3) nipype: python-sphinx (>= 0.6) pebl: python-sphinx pycassa: python-sphinx pymvpa2: python-sphinx pynifti: python-sphinx pypy: python-sphinx (>= 1.0.7+dfsg) pypy3: python-sphinx (>= 1.0.7+dfsg) python-neuroshare: python-sphinx (>= 1.0.7+dfsg) python-pysqlite2: python-sphinx (>= 0.6.1) python-versuchung: python-sphinx renpy: python-sphinx sphinx-patchqueue: python-sphinx vmm: python-sphinx xapian-bindings: python-sphinx Cheers, Olly
Bug#953949: xapian-bindings: please split out python-xapian-doc and use only python3-sphinx to build doc
On Sun, Mar 22, 2020 at 12:10 PM Olly Betts wrote: > > On Sat, Mar 21, 2020 at 06:12:48PM -0400, Sandro Tosi wrote: > > > Having pondered, I'd suggest we just leave xapian-bindings as-is > > > until you're at the point of dropping python2 support from sphinx and > > > then I'll drop the sphinx-generated docs for the python2 bindings > > > from the Debian package entirely. > > > > we're finally in the single digit number of reverse dependencies for > > python-sphinx > > Are you sure? dak rm thinks: yes, many of them are already RC-buggy and excluded from my count (cfr http://sandrotosi.me/debian/py2removal/python-sphinx_1.svg with red border nodes). any opposition on dropping the documentation from python-xapian? Regards, -- Sandro "morph" Tosi My website: http://sandrotosi.me/ Me at Debian: http://wiki.debian.org/SandroTosi Twitter: https://twitter.com/sandrotosi