[Python-modules-team] Bug#776443: sphinx: please make output reproducible

[Chris Lamb]

Source: sphinx
Version: 1.2.3+dfsg-1
Severity: wishlist
Tags: patch
User: reproducible-builds at lists.alioth.debian.org
Usertags: toolchain randomness
X-Debbugs-Cc: reproducible-builds at lists.alioth.debian.org

Hi,

While working on the "reproducible builds" effort [1], we have noticed
that sphinx is generating documentation that is not repoducible.

For example, its output includes non-deterministic memory references
such as:

   <__main__.A at 0x7f68cb685710>

In addition, various generated (objects.inv, searchindex.js,
translations) do not output their keys in a determinstic order,
resulting in further randomness.

The attached patch attempts to remedy these issues. Once applied, many
packages that use sphinx--but alas not sphinx itself yet!--can be built
reproducibly in our current experimental
framework.

 [1]: https://wiki.debian.org/ReproducibleBuilds


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby at debian.org / chris-lamb.co.uk
       `-
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: patch.diff.txt
URL: <http://lists.alioth.debian.org/pipermail/python-modules-team/attachments/20150128/bfae27ab/attachment.txt>