[Python-modules-team] Bug#822197: sphinx: please remove memory addresses from generated python documentation

[Alexis Bienvenüe]

Source: sphinx
Version: 1.3.6-2
Severity: wishlist
Tags: patch upstream
User: reproducible-builds at lists.alioth.debian.org
Usertags: toolchain
X-Debbugs-Cc: reproducible-builds at lists.alioth.debian.org
Control: forwarded -1 https://github.com/sphinx-doc/sphinx/pull/2480

Dear Maintainer,

While working on the “reproducible builds” effort [1], we have noticed
that the documentation generated by sphinx can include the memory
address of some python objects that are used at build time. See for
example, in file
/usr/share/doc/python-kombu-doc/html/reference/kombu.transport.qpid.html
from package python-kombu-doc_3.0.35-1.1 :

  Transport.Connection.Channel.codecs = {'base64':
<kombu.transport.virtual.Base64 object at 0x7f10fff1a590>}

This memory address is irrelevant in the documentation, and prevents the
package building to be reproducible.

The attached patch strips these memory addresses, leading to better
reproducibility.

Regards,
Alexis Bienvenüe.

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


-------------- next part --------------
A non-text attachment was scrubbed...
Name: sphinx_1.3.6-2_rmmem.diff
Type: text/x-patch
Size: 2815 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/python-modules-team/attachments/20160422/7977478c/attachment.bin>