[med-svn] [python-cobra] 09/10: Disable building of documentation until Sphinx 1.3 is available

Afif Elghraoui afif-guest at moszumanska.debian.org
Fri Jul 10 04:26:45 UTC 2015


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

afif-guest pushed a commit to branch master
in repository python-cobra.

commit 9b764866d415a11853503e5fd6b5a17d838dc685
Author: Afif Elghraoui <afif at ghraoui.name>
Date:   Thu Jul 9 21:23:29 2015 -0700

    Disable building of documentation until Sphinx 1.3 is available
---
 debian/README.source              | 12 +++++++++++-
 debian/python-cobra-data.doc-base |  8 --------
 debian/python-cobra-data.install  |  2 +-
 debian/rules                      | 10 +++++++---
 4 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/debian/README.source b/debian/README.source
index bae61c1..ef31131 100644
--- a/debian/README.source
+++ b/debian/README.source
@@ -1,6 +1,16 @@
 python-cobra for Debian
 -----------------------
 
+* Building documentation now requires the sphinx extension "napoleon". It
+  is bundled in Sphinx 1.3 (which is currently in Debian's experimental
+  branch). To work with Sphinx <=1.2, it must be installed separately [1], but
+  it is not available in such a package in Debian. For this reason,
+  documentation is not built in current versions of this package. The
+  commit that disables this building should be reverted when sphinx 1.3
+  enters unstable.
+  
+  1. https://pypi.python.org/pypi/sphinxcontrib-napoleon
+
 * This python package has one Cython module, breaking
 architecture-independence. While the Cython module is not /required/,
 it is highly recommended, so I have the packages build it. This may be the
@@ -11,5 +21,5 @@ Python version-independent data files are distributed in the package
 python-cobra-data.
 
 
- -- Afif Elghraoui <afif at ghraoui.name>, Sat, 20 Jun 2015 14:00:37 -0700
+ -- Afif Elghraoui <afif at ghraoui.name>, Thu,  9 Jul 2015 21:20:19 -0700
 
diff --git a/debian/python-cobra-data.doc-base b/debian/python-cobra-data.doc-base
deleted file mode 100644
index f3f93d2..0000000
--- a/debian/python-cobra-data.doc-base
+++ /dev/null
@@ -1,8 +0,0 @@
-Document: python-cobra
-Title: Debian python-cobra API documentation
-Author: Ali Ebrahim
-Section: Programming/Python
-
-Format: HTML
-Index: /usr/share/doc/python-cobra/html/index.html
-Files: /usr/share/doc/python-cobra/html/*.html
diff --git a/debian/python-cobra-data.install b/debian/python-cobra-data.install
index 8cada73..cb20b55 100644
--- a/debian/python-cobra-data.install
+++ b/debian/python-cobra-data.install
@@ -1,2 +1,2 @@
-documentation/html	usr/share/doc/python-cobra
+#documentation/html	usr/share/doc/python-cobra
 cobra/test/data		usr/share/python-cobra
diff --git a/debian/rules b/debian/rules
index 7546222..e32a999 100755
--- a/debian/rules
+++ b/debian/rules
@@ -8,9 +8,13 @@ include /usr/share/dpkg/default.mk
 %:
 	LC_ALL=C.UTF-8 dh $@ --with python2,python3 --buildsystem=pybuild
 
-override_dh_auto_build:
-	dh_auto_build
-	$(MAKE) -C documentation_builder html
+# Disable building of documentation (see README.source)
+#override_dh_auto_build:
+#	dh_auto_build
+#	$(MAKE) -C documentation_builder html
+
+override_dh_installdocs:
+	dh_installdocs -Xexample
 
 override_dh_install:
 	dh_install -X update_pickles.py --package=python-cobra-data

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-cobra.git



More information about the debian-med-commit mailing list