[Python-modules-commits] [sphinx] 01/01: Update dh_sphinxdoc manpage for the latest changes (closes: #836248).

[Dmitry Shachnev]

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

mitya57 pushed a commit to branch master
in repository sphinx.

commit d6759a4f8ddab594c427a38e537b6ce3b5e2c2d6
Author: Dmitry Shachnev <mitya57 at gmail.com>
Date:   Thu Nov 17 20:55:40 2016 +0300

    Update dh_sphinxdoc manpage for the latest changes (closes: #836248).
---
 debian/changelog                 |  1 +
 debian/dh-sphinxdoc/dh_sphinxdoc | 19 ++++++++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 6535276..b405bcc 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,6 +7,7 @@ sphinx (1.4.8-2) UNRELEASED; urgency=medium
     and Python 3.6 snapshots (fix_autodoc_new_python.diff). Fixes FTBFS.
   * Drop build-dependencies on python[3]-xapian (closes: #842903).
   * Add more tests dependencies to the autopkgtests.
+  * Update dh_sphinxdoc manpage for the latest changes (closes: #836248).
 
  -- Dmitry Shachnev <mitya57 at debian.org>  Wed, 19 Oct 2016 18:22:04 +0300
 
diff --git a/debian/dh-sphinxdoc/dh_sphinxdoc b/debian/dh-sphinxdoc/dh_sphinxdoc
index b8d89d9..680f44a 100755
--- a/debian/dh-sphinxdoc/dh_sphinxdoc
+++ b/debian/dh-sphinxdoc/dh_sphinxdoc
@@ -52,6 +52,22 @@ and generates B<${sphinxdoc:Depends}> substitution variable.
 
 =item *
 
+If the Sphinx RTD theme is used, it replaces known files from this theme with
+symlinks to F</usr/share/sphinx_rtd_theme/>, and adds B<sphinx-rtd-theme-common>
+to B<${sphinxdoc:Depends}>.
+
+=item *
+
+It provides a B<${sphinxdoc:Built-Using}> substitution variable, for tracking
+files which could not be symlinked. Examples of such files are F<*.js> and F<*.css>
+files that are generated from corresponding F<*.js_t> and F<*.css_t> templates,
+and can vary depending on the used theme options (for instance, F<basic.css> file
+is generated from F<basic.css_t> and is included in almost every Sphinx-generated
+documentation). Currently, this variable will contain B<sphinx> and, if the default
+theme is used, B<alabaster>, with their versions (other themes are not supported).
+
+=item *
+
 It removes the F<.doctrees> directory.
 
 =item *
@@ -72,7 +88,8 @@ It removes the F<websupport.js> file.
 
 By default, B<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.
+provide one or more directories, only they will be processed. If documentation
+is not found at I<directory>, an error is raised.
 
 =item B<-X>I<item>, B<--exclude=>I<item>
 

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