Lintian ReportsBETA

Tag versions

Wpackage-contains-python-doctree-file

The tag is present in Lintian version 2.113.26. That is the most recent version we know about.

We use semantic versions. The patch number is a commit step indicator relative to the 2.113.0 release tag in our Git repository.

You can find the detection logic for this version at commit 43a81d7. For merge requests, please use the latest version in the Lintian check files/names.

Visibility: warning

This package appears to contain a pickled cache of reStructuredText (*.rst) documentation in a .doctree 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 --with=sphinxdoc debhelper sequence or to add an explicit call to dh_sphinxdoc. This will then require a dependency on ${sphinxdoc:Depends} for the relevant binary package.

Either prevent the installation of the .doctree file (or parent doctrees directory if there is one) or pass the -d option to sphinx-build(1) 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

For more information please consult:

The following 4 source packages in the archive triggered the tag 13 times (in any Lintian version).

There were no overrides.