Trac #32759: ./configure --disable-doc

This switch will disable the docbuild and avoid installing its many
dependencies (sphinx...).

In contrast to other packages, `pplpy`'s docbuild is enabled unless
explicitly disabled by setting `SAGE_SPKG_INSTALL_DOCS=no`. We move it
to a separate package `pplpy_doc` and make it a dependency of
`sagemath_doc_html`.

Split out from #31396.

We also add `argon2_cffi` and `nbclient` to the packages disabled upon
`--disable-notebook`.

URL: https://trac.sagemath.org/32759
Reported by: mkoeppe
Ticket author(s): Matthias Koeppe, John Palmieri
Reviewer(s): John Palmieri, Matthias Koeppe

Author: Release Manager

Makefile

@@ -225,11 +225,10 @@ TESTALL = ./sage -t --all
 PTESTALL = ./sage -t -p --all
 
 # Flags for ./sage -t --all.
-# By default, include all tests marked 'dochtml' -- see
-# https://trac.sagemath.org/ticket/25345 and
-# https://trac.sagemath.org/ticket/26110.
-TESTALL_FLAGS = --optional=sage,dochtml,optional,external,build
-TESTALL_NODOC_FLAGS = --optional=sage,optional,external,build
+# When the documentation is installed, "optional" also includes all tests marked 'sagemath_doc_html',
+# see https://trac.sagemath.org/ticket/25345, https://trac.sagemath.org/ticket/26110, and
+# https://trac.sagemath.org/ticket/32759
+TESTALL_FLAGS = --optional=sage,optional,external,build
 
 test: all
 	$(TESTALL) --logfile=logs/test.log
@@ -275,25 +274,25 @@ test-nodoc: build
 check-nodoc: test-nodoc
 
 testall-nodoc: build
-	$(TESTALL) $(TESTALL_NODOC_FLAGS) --logfile=logs/testall.log
+	$(TESTALL) $(TESTALL_FLAGS) --logfile=logs/testall.log
 
 testlong-nodoc: build
 	$(TESTALL) --long --logfile=logs/testlong.log
 
 testalllong-nodoc: build
-	$(TESTALL) --long $(TESTALL_NODOC_FLAGS) --logfile=logs/testalllong.log
+	$(TESTALL) --long $(TESTALL_FLAGS) --logfile=logs/testalllong.log
 
 ptest-nodoc: build
 	$(PTESTALL) --logfile=logs/ptest.log
 
 ptestall-nodoc: build
-	$(PTESTALL) $(TESTALL_NODOC_FLAGS) --logfile=logs/ptestall.log
+	$(PTESTALL) $(TESTALL_FLAGS) --logfile=logs/ptestall.log
 
 ptestlong-nodoc: build
 	$(PTESTALL) --long --logfile=logs/ptestlong.log
 
 ptestalllong-nodoc: build
-	$(PTESTALL) --long $(TESTALL_NODOC_FLAGS) --logfile=logs/ptestalllong.log
+	$(PTESTALL) --long $(TESTALL_FLAGS) --logfile=logs/ptestalllong.log
 
 testoptional-nodoc: build
 	$(TESTALL) --logfile=logs/testoptional.log

README.md

@@ -450,7 +450,6 @@ SAGE_ROOT                 Root directory (sage-x.y in Sage tarball)
 │       │
 │       └── tmp/sage/     Temporary files when building Sage
 ├── logs
-│   ├── dochtml.log       Log of the documentation build
 │   ├── install.log       Full install log
 │   └── pkgs              Build logs of individual packages
 │       ├── alabaster-0.7.12.log

build/make/Makefile.in

@@ -54,7 +54,8 @@ SAGE_SPKG_OPTIONS = @SAGE_SPKG_OPTIONS@
 
 # Where the Sage distribution installs documentation.
 # set to empty if --disable-doc is used
-SAGE_DOCS = $(SAGE_LOCAL)
+SAGE_DOCS = @SAGE_DOCS@
+SAGE_DOCS_DISABLED_MESSAGE = This Sage build is configured with "configure --disable-doc", so building the documentation will not work.
 
 # Where the Sage distribution installs Python packages.
 # This can be overridden by 'make SAGE_VENV=/some/venv'.
@@ -219,7 +220,7 @@ endif
 # the doc build takes the most time and should be started as soon as
 # possible.
 all-start: toolchain-deps
-	+$(MAKE_REC) doc all-sage
+	+$(MAKE_REC) all-sage-docs all-sage
 
 # Build everything except the documentation
 all-build: toolchain-deps
@@ -324,7 +325,7 @@ base: $(inst_patch) $(inst_pkgconf)
 #
 # $ ./sage --docbuild -H
 
-doc: $(SAGE_DOCS_INSTALLED_PACKAGE_INSTS) $(SAGE_DOCS_UNINSTALLED_PACKAGES_CLEANS)
+doc: doc-html
 
 # All doc-building is delegated to the script packages
 # sagemath_doc_html, sagemath_doc_pdf
@@ -492,9 +493,15 @@ $$($(4))/$(SPKG_INST_RELDIR)/$(1)-$(2): $(3)
 $(1): $$($(4))/$(SPKG_INST_RELDIR)/$(1)-$(2)
 
 $(1)-$(4)-no-deps:
-	+$(AM_V_at)sage-logger -p 'SAGE_CHECK=$$(SAGE_CHECK_$(1)) PATH=$$($(4))/bin:$$$$PATH $$(SAGE_SPKG) $$(SAGE_SPKG_OPTIONS) \
+	+@if [ -z '$$($(4))' ]; then \
+	    echo "Error: The installation tree $(4) has been disabled" 2>&1; \
+	    echo "$$($(4)_DISABLED_MESSAGE)" 2>&1; \
+	    exit 1; \
+	else \
+	    $(AM_V_at)sage-logger -p 'SAGE_CHECK=$$(SAGE_CHECK_$(1)) PATH=$$($(4))/bin:$$$$PATH $$(SAGE_SPKG) $$(SAGE_SPKG_OPTIONS) \
 		$(if $(filter $(1),$(TOOLCHAIN_DEPS)),--keep-existing) \
-		$(1)-$(2) $$($(4))' '$$(SAGE_LOGS)/$(1)-$(2).log'
+		$(1)-$(2) $$($(4))' '$$(SAGE_LOGS)/$(1)-$(2).log'; \
+	fi
 
 $(1)-no-deps: $(1)-$(4)-no-deps
 
@@ -596,7 +603,11 @@ $$($(4))/$(SPKG_INST_RELDIR)/$(1)-$(2): $(3)
 $(1): $$($(4))/$(SPKG_INST_RELDIR)/$(1)-$(2)
 
 $(1)-$(4)-no-deps:
-	@if [ -x '$$(SAGE_ROOT)/build/pkgs/$(1)/spkg-install' ]; then \
+	+@if [ -z '$$($(4))' ]; then \
+	    echo "Error: The installation tree $(4) has been disabled" 2>&1; \
+	    echo "$$($(4)_DISABLED_MESSAGE)" 2>&1; \
+	    exit 1; \
+	elif [ -x '$$(SAGE_ROOT)/build/pkgs/$(1)/spkg-install' ]; then \
 	    $(AM_V_at)cd '$$(SAGE_ROOT)/build/pkgs/$(1)' && \
 		. '$$(SAGE_ROOT)/src/bin/sage-src-env-config' && \
 		. '$$(SAGE_ROOT)/src/bin/sage-env-config' && \

build/make/install

@@ -107,7 +107,6 @@ during this run of 'make $@'):
 EOF
 
     look_for_errors "$SAGE_LOGS/*.log" 20 "^Error" package >&2
-    look_for_errors "$SAGE_LOGS/../doc*.log" 100 "^Error" documentation >&2
 
     cat >&2 <<EOF
 

build/pkgs/pplpy/dependencies

@@ -1,5 +1,4 @@
-$(PYTHON) $(MP_LIBRARY) gmpy2 cysignals mpfr mpc ppl | $(PYTHON_TOOLCHAIN) $(if $(findstring no,$(SAGE_SPKG_INSTALL_DOCS)),,sphinx)
+$(PYTHON) $(MP_LIBRARY) gmpy2 cysignals mpfr mpc ppl | $(PYTHON_TOOLCHAIN)
 
 ----------
 All lines of this file are ignored except the first.
-It is copied by SAGE_ROOT/build/make/install into SAGE_ROOT/build/make/Makefile.

build/pkgs/pplpy/spkg-install.in

@@ -1,7 +1 @@
 cd src && sdh_pip_install .
-
-# During spkg-install execution, the compiled files are still in a temporary
-# directory and are copied to their destination after the end of the script.
-# As sphinx need theses compiled files, the compilation and installation
-# of pplpy's documentation is done after the end of spkg-install
-# in the spkg-postinst script.

build/pkgs/pplpy/spkg-postinst.in

@@ -0,0 +1,18 @@
+pplpy_doc: Python interface to the Parma Polyhedra Library (documentation)
+==========================================================================
+
+Description
+-----------
+
+PPL Python wrapper (documentation)
+
+License
+-------
+
+GPL version 3
+
+
+Upstream Contact
+----------------
+
+-  https://github.com/videlec/pplpy

build/pkgs/pplpy/spkg-postrm.in

@@ -0,0 +1 @@
+../pplpy/checksums.ini