Bug#1066837: mpi4py: FTBFS: Unable to generate documentation

[Zixing Liu]

Package: mpi4py
Severity: serious
Tags: patch
User: zixing.liu at canonical.com
Usertags: origin-ubuntu noble ubuntu-patch

Dear Maintainer,

mpi4py failed to build from source after Python 3.12 and Sphinx upgrade.
Please find the patch attached that fixes the Sphinx documentation generation
issue and also a partial fix to the InterSphinx online requirements.

Due to a packaging issue in numpy, the InterSphinx of numpy isn't included
in the package, so linking the documentation from numpy is not possible
at the moment.

  * Un-break Sphinx documentation generation by removing PYTHONPATH overrides.
  * Add a patch to make Intersphinx read the cross-documentation index
    from local filesystem. (LP: #2057848)


Thanks for considering the patch.


-- System Information:
Debian Release: bookworm/sid
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 6.5.0-25-generic (SMP w/10 CPU threads; PREEMPT)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_OOT_MODULE
Locale: LANG=en_CA.UTF-8, LC_CTYPE=en_CA.UTF-8 (charmap=UTF-8), LANGUAGE=en_CA:en
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
-------------- next part --------------
diff -Nru mpi4py-3.1.5/debian/control mpi4py-3.1.5/debian/control
--- mpi4py-3.1.5/debian/control	2024-03-13 12:30:07.000000000 -0600
+++ mpi4py-3.1.5/debian/control	2024-03-13 15:33:29.000000000 -0600
@@ -17,7 +16,8 @@
                python3-setuptools
 Build-Depends-Indep: texinfo, texlive,
  latexmk, tex-gyre,
- texlive-latex-extra
+ texlive-latex-extra,
+ python3-doc
 Standards-Version: 4.6.2
 Vcs-Browser: https://salsa.debian.org/science-team/mpi4py
 Vcs-Git: https://salsa.debian.org/science-team/mpi4py.git
diff -Nru mpi4py-3.1.5/debian/patches/intersphinx_use_local_inventory.patch mpi4py-3.1.5/debian/patches/intersphinx_use_local_inventory.patch
--- mpi4py-3.1.5/debian/patches/intersphinx_use_local_inventory.patch	1969-12-31 17:00:00.000000000 -0700
+++ mpi4py-3.1.5/debian/patches/intersphinx_use_local_inventory.patch	2024-03-13 15:33:29.000000000 -0600
@@ -0,0 +1,18 @@
+Description: Use local InterSphinx inventory data
+Author: Zixing Liu <zixing.liu at canonical.com>
+Forwarded: not-needed
+Last-Update: 2024-03-13
+
+Index: mpi4py/docs/source/usrman/conf.py
+===================================================================
+--- mpi4py.orig/docs/source/usrman/conf.py
++++ mpi4py/docs/source/usrman/conf.py
+@@ -90,7 +90,7 @@ autosummary_context = {
+ }
+ 
+ intersphinx_mapping = {
+-    'python': ('https://docs.python.org/3/', None),
++    'python': ('https://docs.python.org/3/', ('/usr/share/doc/python3/html/objects.inv', None)),
+     'numpy': ('https://numpy.org/doc/stable/', None),
+ }
+ 
diff -Nru mpi4py-3.1.5/debian/patches/series mpi4py-3.1.5/debian/patches/series
--- mpi4py-3.1.5/debian/patches/series	2024-02-20 03:49:49.000000000 -0700
+++ mpi4py-3.1.5/debian/patches/series	2024-03-13 15:29:22.000000000 -0600
@@ -7,3 +7,4 @@
 docs_privacy.patch
 io_long_double_i386_2d868d7.patch
 skip_testPackUnpackExternal_sparc64.patch
+intersphinx_use_local_inventory.patch
diff -Nru mpi4py-3.1.5/debian/rules mpi4py-3.1.5/debian/rules
--- mpi4py-3.1.5/debian/rules	2024-02-20 03:49:49.000000000 -0700
+++ mpi4py-3.1.5/debian/rules	2024-03-13 15:28:23.000000000 -0600
@@ -64,8 +64,7 @@
 		--build-args "--mpicc=/usr/bin/mpicc$(MPI) --mpicxx=/usr/bin/mpicxx$(MPI)"
 
 override_dh_auto_build-indep: override_dh_auto_build-arch
-	PYTHONPATH=`pybuild --print "{build_dir}"` \
-	 make -C docs/source/usrman/ html man info latexpdf SPHINXOPTS="-D today=\"$(BUILD_DATE)\""
+	make -C docs/source/usrman/ html man info latexpdf SPHINXOPTS="-D today=\"$(BUILD_DATE)\""
 
 override_dh_auto_install:
 	dh_auto_install