Package: borgbackup-doc
Version: 1.0.0~rc2-3
Severity: wishlist

Currently, the package borgbackup-doc does not build 100% reproducible.

The only problem is api.html, which embeds the current date/time and I/O
charset from the buildd.  The problem occurs when parsing function
default arguments.

The API doc build system tries to evaluate the default argument,
and print the serialized value, rather then copying the initializer
verbatim.

Note that this technically makes the docs wrong (in addition to making
them harder to read), since the program will actually re-evaluate the
initializer at runtime.


Example:

archive.py
> start=datetime.utcnow()

Source:
https://anonscm.debian.org/cgit/collab-maint/borgbackup.git/tree/borg/archive.py?id=73e19357745377abc44c00e38cccf52aaef09273#n135

Possible output:
> <em>start=datetime.datetime(2017</em>, <em>4</em>, <em>7</em>, <em>1</em>, 
> <em>48</em>, <em>28</em>, <em>382881)</em>


to do: Check if there is a sphinx switch to make it copy the
parameter(s) verbatim (the string '=datetime.utcnow()' in this case),
rather than trying to evaluate and serialize them.

Reply via email to