[Python-modules-commits] r17792 - in packages/sphinx/trunk/debian/dh-sphinxdoc (dh_sphinxdoc)

[jwilk at users.alioth.debian.org]

    Date: Sunday, July 10, 2011 @ 17:17:18
  Author: jwilk
Revision: 17792

dh_sphinxdoc: more documentation.

Modified:
  packages/sphinx/trunk/debian/dh-sphinxdoc/dh_sphinxdoc

Modified: packages/sphinx/trunk/debian/dh-sphinxdoc/dh_sphinxdoc
===================================================================
--- packages/sphinx/trunk/debian/dh-sphinxdoc/dh_sphinxdoc	2011-07-10 12:29:16 UTC (rev 17791)
+++ packages/sphinx/trunk/debian/dh-sphinxdoc/dh_sphinxdoc	2011-07-10 17:17:18 UTC (rev 17792)
@@ -35,6 +35,30 @@
 
 =head1 DESCRIPTION
 
+B<dh_sphinxdoc> is a debhelper program that prepares Sphinx-generated
+documentation for inclusion in a Debian package. More specifically:
+
+=over 4
+
+=item *
+
+It checks if all the files referenced by F<searchindex.js> exist.
+
+=item *
+
+It replaces known F<*.js> files with symlinks to F</usr/share/javascript/sphinxdoc/>
+and generates B<${sphinxdoc:Depends}> substitution variable.
+
+=item *
+
+It removes the F<.doctree> directory.
+
+=item *
+
+It removes the F<.buildinfo> file.
+
+=back
+
 =head1 OPTIONS
 
 =over 4