Bug#866166: sagemath: FTBFS with Sphinx 1.5: AttributeError: 'BuildEnvironment' object has no attribute 'citations'

[Tobias Hansen]

Hi Dmitry,

would it be an option to upload sphinx 1.5 to unstable together with
sagemath 8.0 (which works fine with sphinx 1.5) or do you want to do it
before? We plan to upload sagemath 8.0 to unstable when it's released
(they are at beta12 now).

Otherwise it's a matter of backporting commits from sagemath 8.0 to 7.6.

Best,
Tobias

On Tue, 27 Jun 2017 23:12:17 +0300 Dmitry Shachnev <mitya57 at debian.org>
wrote:
> Source: sagemath
> Version: 7.6-2
> Severity: important
> User: python-modules-team at lists.alioth.debian.org
> Usertags: sphinx1.5
> 
> Dear maintainer,
> 
> Sagemath fails to build with Sphinx 1.5 (available in experimental, but
> pending upload to unstable):
> 
>   # Sometimes, parts of the docbuild fail with MemoryError or OSError but
>   # Sage doesn't detect this. Here we detect it and fail the build if so.
>   ! grep Error sage/logs/dochtml.log
>   AttributeError: 'BuildEnvironment' object has no attribute 'citations'
>   WARNING: intersphinx inventory '/<<PKGBUILDDIR>>/debian/build/usr/share/doc/sagemath/inventory/en/reference/objects.inv' not fetchable due to <type 'exceptions.IOError'>: [Errno 2] No such file or directory: '/<<PKGBUILDDIR>>/debian/build/usr/share/doc/sagemath/inventory/en/reference/objects.inv'
>   AttributeError: 'BuildEnvironment' object has no attribute 'citations'
>   (repeats multiple times)
>   debian/rules:90: recipe for target 'check-dochtml-log' failed
> 
> This can be fixed by backporting upstream commit [1], but then it fails with
> dh_sphinxdoc error:
> 
>      debian/rules override_dh_sphinxdoc
>   make[1]: Entering directory '/<<PKGBUILDDIR>>'
>   dh_sphinxdoc -XMathJax.js -Xtranslations.js -Xsearchtools.js
>   dh_sphinxdoc: ignoring unknown JavaScript code: debian/sagemath-doc-ca/usr/share/doc/sagemath/html/ca/intro/_static/mathjax_sage.js
>   dh_sphinxdoc: ignoring unknown JavaScript code: debian/sagemath-doc-ca/usr/share/doc/sagemath/html/ca/intro/_static/thebe-sage.js
>   (more harmless warnings)
>   dh_sphinxdoc: debian/sagemath-doc-en/usr/share/doc/sagemath/html/en/reference/_sources/sage/algebras/affine_nil_temperley_lieb.rst.txt is missing
>   debian/rules:192: recipe for target 'override_dh_sphinxdoc' failed
> 
> This is most probably related to a change in Sphinx [2], which changed how
> searchtools.js looks for source files. dh_sphinxdoc now follows the same
> logic and expects to find these files in their new locations.
> 
> [1]: https://github.com/sagemath/sage/commit/78e671810360d3e0
> [2]: https://github.com/sphinx-doc/sphinx/pull/2454
> 
> --
> Dmitry Shachnev