[Python-modules-commits] [python-releases] 07/14: add new python-releases-doc binary package containing the Sphinx documentation

Jan Dittberner jandd at moszumanska.debian.org
Sat Jan 30 19:14:03 UTC 2016 

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

jandd pushed a commit to branch master
in repository python-releases.

commit 9508642c62b9647249c3d591b6d7b55ec961330c
Author: Jan Dittberner <jandd at debian.org>
Date:   Sat Jan 30 18:28:26 2016 +0100

    add new python-releases-doc binary package containing the Sphinx documentation
    
    * add new python-releases-doc binary package containing the Sphinx
      documentation
      - add stanza to debian/control, add python-sphinx to Build-Depends
      - add sphinx-build invocation in debian/rules
      - add docs/_build/ to debian/clean
      - add debian/python-releases-doc.doc-base and
        debian/python-releases-doc.docs files
---
 debian/changelog                    | 11 +++++++++--
 debian/clean                        |  1 +
 debian/control                      | 30 +++++++++++++++++++++++++++++-
 debian/python-releases-doc.doc-base |  9 +++++++++
 debian/python-releases-doc.docs     |  1 +
 debian/rules                        | 16 +++++++++++++++-
 6 files changed, 64 insertions(+), 4 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 62b82cb..8362712 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,8 +6,15 @@ python-releases (1.0.0-1) UNRELEASED; urgency=medium
   * Disable tests in debian/rules because they require spec which is not
     packaged for debian yet, remove python{3,}-docutils from Build-Depends
   * New upstream version
-
- -- Jan Dittberner <jandd at debian.org>  Sat, 30 Jan 2016 17:37:53 +0100
+  * add new python-releases-doc binary package containing the Sphinx
+    documentation
+    - add stanza to debian/control
+    - add sphinx-build invocation in debian/rules
+    - add docs/_build/ to debian/clean
+    - add debian/python-releases-doc.doc-base and
+      debian/python-releases-doc.docs files
+
+ -- Jan Dittberner <jandd at debian.org>  Sat, 30 Jan 2016 18:02:20 +0100
 
 python-releases (0.7.0-2) unstable; urgency=medium
 
diff --git a/debian/clean b/debian/clean
index 3feb78a..82c00ae 100644
--- a/debian/clean
+++ b/debian/clean
@@ -1 +1,2 @@
 *.egg-info/
+docs/_build/
diff --git a/debian/control b/debian/control
index c328d34..547e023 100644
--- a/debian/control
+++ b/debian/control
@@ -7,10 +7,11 @@ Build-Depends: debhelper (>= 9),
                dh-python,
                python-all,
                python-setuptools,
+               python-sphinx,
                python3-all,
                python3-setuptools
 Standards-Version: 3.9.6
-X-Python-Version: >= 2.6
+X-Python-Version: >= 2.7
 X-Python3-Version: >= 3.2
 Vcs-Git: https://anonscm.debian.org/git/python-modules/packages/python-releases.git
 Vcs-Browser: https://anonscm.debian.org/cgit/python-modules/packages/python-releases.git
@@ -20,6 +21,7 @@ Package: python-releases
 Architecture: all
 Depends: python-docutils, ${misc:Depends}, ${python:Depends}
 Enhances: python-sphinx
+Suggests: python-releases-doc
 Description: Sphinx extension for changelog manipulation (Python 2)
  Releases is a Sphinx extension designed to help you keep a source control
  friendly, merge friendly changelog file & turn it into useful, human readable
@@ -45,6 +47,7 @@ Package: python3-releases
 Architecture: all
 Depends: python3-docutils, ${misc:Depends}, ${python3:Depends}
 Enhances: python3-sphinx
+Suggests: python-releases-doc
 Description: Sphinx extension for changelog manipulation (Python 3)
  Releases is a Sphinx extension designed to help you keep a source control
  friendly, merge friendly changelog file & turn it into useful, human readable
@@ -65,3 +68,28 @@ Description: Sphinx extension for changelog manipulation (Python 3)
      overridden on a per-issue basis.
  .
  This package contains the python3.x version of the library
+
+Package: python-releases-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends}, ${sphinxdoc:Depends}
+Description: Sphinx extension for changelog manipulation documentation
+ Releases is a Sphinx extension designed to help you keep a source control
+ friendly, merge friendly changelog file & turn it into useful, human readable
+ HTML output.
+ .
+ Specifically:
+ .
+   * The source format (kept in your Sphinx tree as ``changelog.rst``) is a
+     stream-like timeline that plays well with source control & only requires
+     one entry per change (even for changes that exist in multiple release
+     lines).
+   * The output (when you have the extension installed and run your Sphinx
+     build command) is a traditional looking changelog page with a section for
+     every release; multi-release issues are copied automatically into each
+     release.
+   * By default, feature and support issues are only displayed under feature
+     releases, and bugs are only displayed under bugfix releases. This can be
+     overridden on a per-issue basis.
+ .
+ This package contains the documentation for releases.
diff --git a/debian/python-releases-doc.doc-base b/debian/python-releases-doc.doc-base
new file mode 100644
index 0000000..08bf23b
--- /dev/null
+++ b/debian/python-releases-doc.doc-base
@@ -0,0 +1,9 @@
+Document: python-releases-doc
+Title: Debian python-releases Manual
+Abstract: This manual describes what python-releases is and how it can be
+ helpful to provide proper changelogs for Sphinx documentation.
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-releases-doc/html/index.html
+Files: /usr/share/doc/python-releases-doc/html/*.html
diff --git a/debian/python-releases-doc.docs b/debian/python-releases-doc.docs
new file mode 100644
index 0000000..4ecc793
--- /dev/null
+++ b/debian/python-releases-doc.docs
@@ -0,0 +1 @@
+docs/_build/html
diff --git a/debian/rules b/debian/rules
index 18b5e41..bbfcecd 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,8 +1,22 @@
 #!/usr/bin/make -f
+# -*- makefile -*-
+
+# Uncomment this to turn on verbose mode.
+#export DH_VERBOSE=1
 export PYBUILD_NAME=releases
 
 # tests will not run properly because spec is not packaged yet
 export PYBUILD_DISABLE=test
 
 %:
-	dh $@ --with=python2,python3 --buildsystem=pybuild
+	dh $@ --with=python2,python3,sphinxdoc --buildsystem=pybuild
+
+override_dh_auto_build:
+	PYTHONPATH=. sphinx-build -b html -d docs/_build/.doctrees -N docs docs/_build/html
+	dh_auto_build
+
+override_dh_installchangelogs:
+	dh_installchangelogs -- docs/changelog.rst
+
+override_dh_compress:
+	dh_compress -X changelog.html

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

More information about the Python-modules-commits mailing list