blob: cd772380fa825c48237e0e5e796f721b82017207 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
Tag: package-contains-python-doctree-file
Severity: warning
Check: files/names
Explanation: This package appears to contain a pickled cache of reStructuredText
(*.rst) documentation in a <code>.doctree</code> file.
.
These are not needed to display the documentation correctly and as they can
contain absolute build paths can affect the reproducibility of the package.
.
The easiest way to prevent this is to use the <code>--with=sphinxdoc</code>
debhelper sequence or to add an explicit call to
<code>dh_sphinxdoc</code>. This will then require a dependency on
<code>${sphinxdoc:Depends}</code> for the relevant binary package.
.
Either prevent the installation of the <code>.doctree</code> file (or parent
<code>doctrees</code> directory if there is one) or pass the <code>-d</code>
option to <code>sphinx-build(1)</code> to create the caches elsewhere.
.
For example:
.
override_dh_auto_build:
dh_auto_build
PYTHONPATH=. sphinx-build -bman docs/ -d debian/doctrees docs/build/html
PYTHONPATH=. sphinx-build -bhtml docs/ -d debian/doctrees docs/build/html
.
override_dh_auto_clean:
dh_auto_clean
rm -rf debian/doctrees
See-Also: http://sphinx-doc.org/invocation.html#cmdoption-sphinx-build-d
|