sagemathgh-38224: configure --disable-notebook: Also disable `jupyt…

…er_sphinx`       `jupyter_sphinx` is only needed for the live documentation and for some illustrations in `src/doc/en/tutorial/latex.rst`. We conditionalize the use of this extension using a Feature. `configure --disable-notebook` now also disables `jupyter_sphinx`, to avoid pulling in lots of Jupyter packages via its dependencies (including `jsonschema`, which has gotten itself a Rust-based dependency, see sagemath#38219). This implements the policy for use of platform-dependent wheels proposed in sagemath#38219 ("if a platform-dependent ``wheel`` package is a standard package, there must be a ``configure`` option that disables it"). We also repair the mechanism for conditional documentation based on feature tags. In particular, the link for Boolean polynomials is restored. https://doc-pr-38224-- sagemath.netlify.app/html/en/reference/polynomial_rings/#boolean- polynomials ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies    - Depends on sagemath#38468 (merged here) URL: sagemath#38224 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
vbraun · Aug 26, 2024 · 9cf70eb · 9cf70eb
2 parents e24f133 + 33a114c
commit 9cf70eb
Show file tree

Hide file tree

Showing 40 changed files with 240 additions and 28 deletions.
diff --git a/.ci/create-changes-html.sh b/.ci/create-changes-html.sh
@@ -1,11 +1,12 @@
 #!/bin/sh
 if [ $# != 2 ]; then
-    echo >&2 "usage: $0 BASE_DOC_COMMIT DOC_REPO"
-    echo >&2 "creates CHANGES.html in the current directory"
-    echo >&2 "for the diffs of DOC_REPO against BASE_DOC_COMMIT"
+    echo >&2 "Usage: $0 DIFF_TEXT DOC_REPO"
+    echo >&2 "This script generates a CHANGES.html file in the current directory"
+    echo >&2 "and adds anchor targets in the documents within DOC_REPO"
+    echo >&2 "based on the diff hunks in the DIFF_TEXT file."
     exit 1
 fi
-BASE_DOC_COMMIT="$1"
+DIFF_TEXT="$1"
 DOC_REPOSITORY="$2"
 
 # Create CHANGES.html
@@ -52,11 +53,10 @@ diffParagraphs.forEach(paragraph => {
 EOF
 echo '</head>' >> CHANGES.html
 echo '<body>' >> CHANGES.html
-(cd $DOC_REPOSITORY && git diff $BASE_DOC_COMMIT -- "*.html") > diff.txt
 python3 - << EOF
 import os, re, html
 from itertools import chain
-with open('diff.txt', 'r') as f:
+with open('$DIFF_TEXT', 'r') as f:
     diff_text = f.read()
 diff_blocks = re.split(r'^(?=diff --git)', diff_text, flags=re.MULTILINE)
 out_blocks = []
@@ -83,12 +83,21 @@ for block in diff_blocks:
                     hunk_lines = []
                 search_result = re.search(r'@@ -(\d+),(\d+) \+(\d+),(\d+)', line)
                 if search_result:
-                    line_number = int(search_result.group(3))
+                    line_number = int(search_result.group(3)) - 1
                     span = int(search_result.group(4))
                     for i in chain(range(line_number, line_number + span), range(line_number - 1, -1, -1)):
-                        if content[i].startswith('<') and not content[i].startswith('</'):
+                        try:
+                            ln = content[i]
+                        except IndexError:
+                            continue
+                        for idx, char in enumerate(ln):
+                            if not char.isspace():
+                                break
+                        else:
+                            idx = len(ln)
+                        if ln.startswith('<', idx) and not ln.startswith('</', idx):
                             count += 1
-                            content[i] = f'<span id="hunk{count}" style="visibility: hidden;"></span>' + content[i]
+                            content[i] = ln[:idx] + f'<span id="hunk{count}" style="visibility: hidden;"></span>' + ln[idx:]
                             hunks.append(f'<p class="hunk"><a href="{path}#hunk{count}" class="hunk" target="_blank">hunk #{count}</a></p>')
                             break
             hunk_lines.append(line)
@@ -107,4 +116,4 @@ EOF
 cat diff.html >> CHANGES.html
 echo '</body>' >> CHANGES.html
 echo '</html>' >> CHANGES.html
-rm diff.txt diff.html
+rm diff.html
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -204,9 +204,10 @@ jobs:
                                                   -e 's;#L[0-9]*";";' \
              && git commit -a -m 'wipe-out')
             # Since HEAD is at commit 'wipe-out', HEAD~1 is commit 'new' (new doc), HEAD~2 is commit 'old' (old doc)
-            .ci/create-changes-html.sh $(cd doc && git rev-parse HEAD~2) doc
-            # Restore the new doc with changes made in create-changes-html.sh but dropping changes by "wipe out"
-            (cd doc && git stash -q && git checkout -q -f HEAD~1 && git stash pop -q)
+            (cd doc && git diff $(git rev-parse HEAD~2) -- "*.html") > diff.txt
+            # Restore the new doc dropping changes by "wipe out"
+            (cd doc && git checkout -q -f HEAD~1)
+            .ci/create-changes-html.sh diff.txt doc
             # Sometimes rm -rf .git errors out because of some diehard hidden files
             # So we simply move it out of the doc directory
             (cd doc && mv .git ../git && mv .gitattributes ../gitattributes)

diff --git a/build/pkgs/sagemath_doc_html/dependencies b/build/pkgs/sagemath_doc_html/dependencies
@@ -1,4 +1,4 @@
-sagelib sphinx sphinx_copybutton sphinx_inline_tabs pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol ipywidgets jupyter_sphinx sage_docbuild elliptic_curves furo fpylll graphs
+sagelib sphinx sphinx_copybutton sphinx_inline_tabs pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol ipywidgets sage_docbuild elliptic_curves furo fpylll graphs
 
 # Building the documentation has many dependencies, because all
 # documented modules are imported and because we use matplotlib to

diff --git a/build/pkgs/sagemath_doc_html/dependencies_optional b/build/pkgs/sagemath_doc_html/dependencies_optional
@@ -0,0 +1 @@
+jupyter_sphinx
diff --git a/configure.ac b/configure.ac
@@ -450,7 +450,7 @@ AC_ARG_ENABLE([cvxopt],
 AC_ARG_ENABLE([notebook],
   AS_HELP_STRING([--disable-notebook],
                  [disable build of the Jupyter notebook and related packages]), [
-    for pkg in notebook nbconvert beautifulsoup4 sagenb_export nbformat nbclient terminado send2trash prometheus_client mistune pandocfilters bleach defusedxml jsonschema jupyter_jsmol argon2_cffi argon2_cffi_bindings webencodings tinycss2 ipympl soupsieve fastjsonschema anyio arrow async_lru fqdn isoduration json5 jsonpointer jsonschema_specifications jupyter_events jupyter_lsp jupyter_server jupyter_server_terminals jupyterlab jupyterlab_server jupyterlab_pygments jupyterlab_mathjax2 notebook_shim overrides python_json_logger pyyaml referencing rfc3339_validator rfc3986_validator sniffio types_python_dateutil uri_template webcolors websocket_client; do
+    for pkg in notebook nbconvert beautifulsoup4 sagenb_export nbformat nbclient terminado send2trash prometheus_client mistune pandocfilters bleach defusedxml jsonschema jupyter_jsmol argon2_cffi argon2_cffi_bindings webencodings tinycss2 ipympl soupsieve fastjsonschema anyio arrow async_lru fqdn isoduration json5 jsonpointer jsonschema_specifications jupyter_events jupyter_lsp jupyter_server jupyter_server_terminals jupyterlab jupyterlab_server jupyterlab_pygments jupyterlab_mathjax2 jupyter_sphinx notebook_shim overrides python_json_logger pyyaml referencing rfc3339_validator rfc3986_validator sniffio types_python_dateutil uri_template webcolors websocket_client; do
       AS_VAR_SET([SAGE_ENABLE_$pkg], [$enableval])
     done
   ])

diff --git a/src/doc/ca/intro/conf.py b/src/doc/ca/intro/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/de/a_tour_of_sage/conf.py b/src/doc/de/a_tour_of_sage/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/de/thematische_anleitungen/conf.py b/src/doc/de/thematische_anleitungen/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/de/tutorial/conf.py b/src/doc/de/tutorial/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/el/a_tour_of_sage/conf.py b/src/doc/el/a_tour_of_sage/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/a_tour_of_sage/conf.py b/src/doc/en/a_tour_of_sage/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/constructions/conf.py b/src/doc/en/constructions/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/developer/conf.py b/src/doc/en/developer/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/faq/conf.py b/src/doc/en/faq/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/installation/conf.py b/src/doc/en/installation/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/prep/conf.py b/src/doc/en/prep/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/reference/conf.py b/src/doc/en/reference/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release, latex_elements, exclude_patterns
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/reference/conf_sub.py b/src/doc/en/reference/conf_sub.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release, exclude_patterns
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/thematic_tutorials/conf.py b/src/doc/en/thematic_tutorials/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/conf.py b/src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/thematic_tutorials/numerical_sage/conf.py b/src/doc/en/thematic_tutorials/numerical_sage/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/tutorial/conf.py b/src/doc/en/tutorial/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/en/tutorial/latex.rst b/src/doc/en/tutorial/latex.rst
@@ -49,7 +49,7 @@ output of the entered commands automatically. You can start this
 automatic rendering by executing ``%display latex`` (and stop by executing
 ``%display plain``).
 
-.. ONLY:: html
+.. ONLY:: html and feature_jupyter_sphinx
 
     Thus, in the Jupyter notebook, you get
 

diff --git a/src/doc/en/website/conf.py b/src/doc/en/website/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/es/a_tour_of_sage/conf.py b/src/doc/es/a_tour_of_sage/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/es/tutorial/conf.py b/src/doc/es/tutorial/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/fr/a_tour_of_sage/conf.py b/src/doc/fr/a_tour_of_sage/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release, latex_elements
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/fr/tutorial/conf.py b/src/doc/fr/tutorial/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release, latex_elements
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/hu/a_tour_of_sage/conf.py b/src/doc/hu/a_tour_of_sage/conf.py
@@ -15,6 +15,11 @@
 from sage_docbuild.conf import release
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the

diff --git a/src/doc/it/a_tour_of_sage/conf.py b/src/doc/it/a_tour_of_sage/conf.py
@@ -13,6 +13,11 @@
 from sage_docbuild.conf import release, latex_elements
 from sage_docbuild.conf import *  # NOQA
 
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
 # Add any paths that contain custom static files (such as style sheets),
 # relative to this directory to html_static_path. They are copied after the
 # builtin static files, so a file named "default.css" will overwrite the