Package HTML documentation

debian/control

@@ -8,6 +8,7 @@ Build-Depends: debhelper-compat (= 13),
                python3-all,
                python3-setuptools,
                python3-pytest,
+               python3-sphinx,
 Standards-Version: 4.6.2
 Rules-Requires-Root: no
 Homepage: https://gitlab.inria.fr/bleuse/procset.py
@@ -16,6 +17,7 @@ Vcs-Browser: https://gitlab.inria.fr/bleuse/procset.py
 
 Package: python3-procset
 Architecture: all
+Suggests: python-procset-doc,
 Depends: ${misc:Depends},
          ${python3:Depends},
 Description: Pure Python implementation of the interval set data structure
@@ -29,3 +31,22 @@ Description: Pure Python implementation of the interval set data structure
  additional ability to access its elements by position.
  .
  This is the Python 3 package.
+
+Package: python-procset-doc
+Architecture: all
+Multi-Arch: foreign
+Depends: ${misc:Depends},
+         ${sphinxdoc:Depends},
+	 libjs-mathjax,
+Section: doc
+Description: Pure Python implementation of the interval set data structure (doc)
+ An interval set (provided as the ProcSet class) is a memory-efficient
+ representation of closed-interval sets.
+ A ProcSet is an hybrid between a set and a list of indexes.
+ More precisely, a ProcSet object is an ordered collection of unique
+ non-negative int.
+ It supports most of set operations: notably membership testing, mathematical
+ operations such as intersection, union, and (symmetric) difference; with the
+ additional ability to access its elements by position.
+ .
+ This package contains the HTML documentation.

debian/patches/force-local-mathjax.patch

+Description: Force use of local MathJax instead of CDN
+Bug-debian: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=989649
+Last-Update: 2023-05-22
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+Index: procset.git/docs/conf.py
+===================================================================
+--- procset.git.orig/docs/conf.py
++++ procset.git/docs/conf.py
+@@ -201,3 +201,9 @@ autoclass_content = 'both'
+ # -- Options for intersphinx extension ---------------------------------------
+ 
+ intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
++
++
++# -- Options for mathjax extension -------------------------------------------
++
++# see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=989649
++mathjax_path = 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'

debian/patches/remove-badges-from-documentation.patch

+Description: Remove badges from documentation
+Author: Raphaël Bleuse <cs@research.bleuse.net>
+Forwarded: no
+Last-Update: 2023-05-22
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+Index: procset.git/docs/_templates/badges.html
+===================================================================
+--- procset.git.orig/docs/_templates/badges.html
++++ /dev/null
+@@ -1,8 +0,0 @@
+-<ul>
+-	<li>
+-		<a href="https://pypi.org/project/procset/"><img alt="PyPI project page" src="https://img.shields.io/pypi/v/procset.svg?style=flat-square"></a>
+-	</li>
+-	<li>
+-		<a href="https://gitlab.inria.fr/bleuse/procset.py"><img alt="git repository" src="https://img.shields.io/badge/src-procset-blue.svg?style=flat-square"></a>
+-	</li>
+-</ul>
+Index: procset.git/docs/conf.py
+===================================================================
+--- procset.git.orig/docs/conf.py
++++ procset.git/docs/conf.py
+@@ -108,7 +108,6 @@ html_static_path = ['_static']
+ html_sidebars = {
+     '**': [
+         'about.html',
+-        'badges.html',
+         'navigation.html',
+         'relations.html',
+         'searchbox.html',

debian/patches/series

 drop-code-coverage.patch
 remove-deprecated-code.patch
+remove-badges-from-documentation.patch
+force-local-mathjax.patch

debian/python-procset-doc.doc-base

+Document: python-procset-doc
+Title: procset User Documentation
+Author: Raphaël Bleuse
+Abstract: A pure Python implementation of the interval set data structure.
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python3-procset/html/index.html
+Files: /usr/share/doc/python3-procset/html/*
+
+Format: Text
+Files: /usr/share/doc/python3-procset/rst/*

debian/python-procset-doc.docs

+docs/_build/html/

debian/python-procset-doc.links

+usr/share/doc/python3-procset/html/_sources usr/share/doc/python3-procset/rst

debian/rules

@@ -5,7 +5,15 @@ export PYBUILD_NAME=procset
 export PYBUILD_TEST_PYTEST=1
 
 %:
-	dh $@ --with python3 --buildsystem=pybuild
+	dh $@ --with python3,sphinxdoc --buildsystem=pybuild
+
+execute_after_dh_auto_build:
+	$(MAKE) --directory=docs html
+
+override_dh_installdocs:
+	dh_installdocs --package=python-procset-doc --doc-main-package=python3-procset
+	dh_installdocs --remaining-packages
 
 execute_after_dh_auto_clean:
+	$(MAKE) --directory=docs clean
 	$(RM) --recursive -- src/procset.egg-info/