[Python-modules-commits] [sphinx] 01/01: Add a note that dh_sphinxdoc does not actually build the documentation.

[Dmitry Shachnev]

This is an automated email from the git hooks/post-receive script.

mitya57 pushed a commit to branch debian/master
in repository sphinx.

commit 5b2efffcaae8c915c009b3d399f5fbc6715b402d
Author: Dmitry Shachnev <mitya57 at gmail.com>
Date:   Thu Sep 28 19:44:38 2017 +0300

    Add a note that dh_sphinxdoc does not actually build the documentation.
---
 debian/changelog                 | 7 +++++++
 debian/dh-sphinxdoc/dh_sphinxdoc | 8 ++++++++
 2 files changed, 15 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index efb5d68..6c7d085 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+sphinx (1.6.4-2) UNRELEASED; urgency=medium
+
+  * Add a note that dh_sphinxdoc does not actually build the documentation
+    to its manpage.
+
+ -- Dmitry Shachnev <mitya57 at debian.org>  Thu, 28 Sep 2017 19:44:01 +0300
+
 sphinx (1.6.4-1) unstable; urgency=medium
 
   * New upstream release.
diff --git a/debian/dh-sphinxdoc/dh_sphinxdoc b/debian/dh-sphinxdoc/dh_sphinxdoc
index 0d7f602..3512c96 100755
--- a/debian/dh-sphinxdoc/dh_sphinxdoc
+++ b/debian/dh-sphinxdoc/dh_sphinxdoc
@@ -80,6 +80,14 @@ It removes the F<websupport.js> file.
 
 =back
 
+Note that B<dh_sphinxdoc> does not build the documentation, it only performs
+the above operations when the documentation is already installed into the
+package build path. To build the docs, please use L<sphinx-build(1)> command
+or B<python3 -m sphinx> syntax.
+
+You can pass B<--with sphinxdoc> to L<dh(1)> to make it automatically call
+B<dh_sphinxdoc> after B<dh_install>.
+
 =head1 OPTIONS
 
 =over 4

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/sphinx.git