Your message dated Sat, 16 Jun 2018 19:20:24 +0000 with message-id <e1fugkk-000h7g...@fasolo.debian.org> and subject line Bug#901662: fixed in sphinx 1.7.5-2 has caused the Debian Bug report #901662, regarding sphinx: RTD theme users FTBFS with dh_sphinxdoc: DOCUMENTATION_OPTIONS does not define URL_ROOT to be marked as done.
This means that you claim that the problem has been dealt with. If this is not the case it is now your responsibility to reopen the Bug report if necessary, and/or fix the problem forthwith. (NB: If you are a system administrator and have no idea what this message is talking about, this may indicate a serious mail system misconfiguration somewhere. Please contact ow...@bugs.debian.org immediately.) -- 901662: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=901662 Debian Bug Tracking System Contact ow...@bugs.debian.org with problems
--- Begin Message ---Source: sphinx Version: 1.7.5-1 Severity: serious Control: tags -1 patch Control: affects -1 src:theano src:python-jira (These are the ones I've actually checked; I suspect most/all of the ~100 packages that build-depend on *-sphinx-rtd-theme are affected.) sphinx's included themes have layout.html reference a separate file documentation_options.js (for compatibility with strict CSS policies [0]). However, sphinx-rtd-theme (and possibly other 3rd party themes - I haven't checked) still uses the old method of defining DOCUMENTATION_OPTIONS as inline JavaScript within the layout.html file [1]. In documentation using this theme, documentation_options.js exists (presumably from sphinx's default template) but isn't actually used. In 1.7.5, sphinx started passing the parameter data-url_root from layout.html to documentation_options.js [2], and dh_sphinxdoc also reads this parameter. This dh_sphinxdoc check assumes that if documentation_options.js exists it is used, and hence errors out if documentation_options.js expects a data-url_root parameter but layout.html doesn't pass one. This causes documentation using sphinx-rtd-theme to FTBFS with dh_sphinxdoc: DOCUMENTATION_OPTIONS does not define URL_ROOT [0] https://github.com/sphinx-doc/sphinx/pull/4295 [1] https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html Discussion of whether this should change: https://github.com/rtfd/sphinx_rtd_theme/issues/414 [2] https://github.com/sphinx-doc/sphinx/commit/a7c6cb018067d735a470a0687248912c6148977d#diff-d108032640b69e79b413796eace2046f Possible (but very minimally tested) fix: --- a/debian/dh-sphinxdoc/dh_sphinxdoc +++ b/debian/dh-sphinxdoc/dh_sphinxdoc @@ -252,7 +252,7 @@ sub sanity_check($$) grep { s/[?#].*//; $js{$_} = 1 unless m/^[a-z][a-z0-9.+-]*:/i or excludefile("$path/$_"); } $search =~ m{<script type="text/javascript" src="([^"]++)"></script>}g; my $documentation_options; my $documentation_options_fn = "$path/_static/documentation_options.js"; - if (-f $documentation_options_fn) + if ($search =~ $documentation_options_fn) { open(my $fh, '<', $documentation_options_fn) or error("cannot open $documentation_options_fn"); $documentation_options = <$fh>;
--- End Message ---
--- Begin Message ---Source: sphinx Source-Version: 1.7.5-2 We believe that the bug you reported is fixed in the latest version of sphinx, which is due to be installed in the Debian FTP archive. A summary of the changes between this version and the previous one is attached. Thank you for reporting the bug, which will now be closed. If you have further comments please address them to 901...@bugs.debian.org, and the maintainer will reopen the bug report if appropriate. Debian distribution maintenance software pp. Dmitry Shachnev <mity...@debian.org> (supplier of updated sphinx package) (This message was generated automatically at their request; if you believe that there is a problem with it please contact the archive administrators by mailing ftpmas...@ftp-master.debian.org) -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 Format: 1.8 Date: Sat, 16 Jun 2018 21:54:03 +0300 Source: sphinx Binary: python-sphinx python3-sphinx sphinx-common sphinx-doc libjs-sphinxdoc Architecture: source Version: 1.7.5-2 Distribution: unstable Urgency: medium Maintainer: Debian Python Modules Team <python-modules-t...@lists.alioth.debian.org> Changed-By: Dmitry Shachnev <mity...@debian.org> Description: libjs-sphinxdoc - JavaScript support for Sphinx documentation python-sphinx - documentation generator for Python projects (implemented in Pytho python3-sphinx - documentation generator for Python projects (implemented in Pytho sphinx-common - documentation generator for Python projects - common data sphinx-doc - documentation generator for Python projects - documentation Closes: 901662 Changes: sphinx (1.7.5-2) unstable; urgency=medium . * dh_sphinxdoc: Fix for templates that do not use documentation_options.js (closes: #901662, thanks Rebecca N. Palmer for the bug report). Checksums-Sha1: de211e8cb9c2b77dd1f927994ca4e2241782dc26 3783 sphinx_1.7.5-2.dsc c4350482d8f78201e9bf0b9a4c2bd55d30558d6e 36564 sphinx_1.7.5-2.debian.tar.xz 784472619e71467c455c5aa7c0add97e6f13e8e1 5228 sphinx_1.7.5-2_source.buildinfo Checksums-Sha256: bdd43cfce6c77872ccffc22665c79f758c9feadc71e367b60f80069c85ad2b01 3783 sphinx_1.7.5-2.dsc 016a6b3b1c38bd1c95b66fd50bdd7b5544ba45af8329319855873a7b5c6dacfa 36564 sphinx_1.7.5-2.debian.tar.xz 2db7195e0c9ca35d423157b51b0e363d4fa2d3ec1e575d1703ef84c461d15bae 5228 sphinx_1.7.5-2_source.buildinfo Files: e58157fda42379960cdcb5823bf6b9ea 3783 python optional sphinx_1.7.5-2.dsc caebc09f1c7a2c4bcbeed76e1404db95 36564 python optional sphinx_1.7.5-2.debian.tar.xz 81779429f8c7a06706974e11cc3267b6 5228 python optional sphinx_1.7.5-2_source.buildinfo -----BEGIN PGP SIGNATURE----- iQJHBAEBCgAxFiEEbEPcK+5mZmLK5jNU1v5xA2P4XdMFAlslXgoTHG1pdHlhNTdA ZGViaWFuLm9yZwAKCRDW/nEDY/hd06T5D/4meZ73r8mMi24eqNsfkoSoZb2ARuwt FgejcXvNpyoFIGLuOoOHTxtUPkp5J0hMYOtB5E19A4Y9+ioRo0w3qh5o7tx27n1O n6ae6Ps4TWtPwJwVgTmRRvdcc3z1ppjMhyTTm04OepGd+jk2L3Rv9PPRLsnyWrRz mHs9x0yG+ZPljoA5/SXrHNK/QbFNPtD3igGI7f3pvT85xSkkDNtMQblh1hlc436i S94/P97vHZUYob6L1jBjOsN4a7gw0atvvOlD034R9kGka4LK9v8Uixqqk8AU5kXB DxfQHwzdFDjzIsIRCaTIWrtsW/zEWkUNQFH12Lrdc8gew6JFLGPVVHu56+DOc8aG bVP2C6CM4FRhRBS1XL0wms09XUwc3ft+YCBdpBWzJS7akWU+wILpljuPBDTZReuZ SGzyXr3zEkNrsHz5UrvxeAz8A/p0z7H16UvwC8CRvmusAFofYp+B83C3P1NR+Xlz ShPStWqCWs4vT7/uc5eI5rRqFyuN8PFAIoj2zWQfLquoJslzX3zKnat48Se99rrn /v84uoJtuKl+k5g2IbryznvZ4HRkihqVb4o8M+R6hL/NxqJ4fmGgTd0IhvKvCOiM lUvNsb/tX4mbNXE0nz1+6KwUXqLRBx5aO6ZFIlgq4nru9evERlboumorqOoszpHY SUmZZo6RtLLb6g== =1Dvs -----END PGP SIGNATURE-----
--- End Message ---
