dh_sphinxdoc(1)
helps with packaging Sphinx-generated documentation
SYNOPSIS
dh_sphinxdoc [debhelper options] [-Xitem] [directory...]
DESCRIPTION
dh_sphinxdoc is a debhelper program that prepares Sphinx-generated
documentation for inclusion in a Debian package. More specifically:
-
It checks if all the files referenced by searchindex.js exist.
-
It replaces known *.js files with symlinks to /usr/share/javascript/sphinxdoc/
and generates ${sphinxdoc:Depends} substitution variable.
-
It removes the .doctrees directory.
-
It removes the .buildinfo file.
-
It removes the websupport.js file.
OPTIONS
- directory
-
By default, dh_sphinxdoc scans your package looking for directories looking
like they contain Sphinx-generated documentation. However, if you explicitly
provide one or more directories, only they will be processed.
- -Xitem, --exclude=item
-
Exclude files that contain item anywhere in their filename from
being symlinked, removed or checked for existence.
BUGS
Symlinking translations.js and non-English searchtools.js is not supported.
