Skip to content

Docbuild fails because it looks for ambient sagmath jupyter kernel #40605

@vbraun

Description

@vbraun

Environment

The documentation build tries to create a blank jupyter notebook with the sagemath kernel, and fails:

[sagemath_doc_pdf-none] [spkg-install] [tutorial ] * sphinx_copybutton (0.5.2)                                                                             
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] * sphinx_inline_tabs (2023.04.21)                                                                       
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] * IPython.sphinxext.ipython_directive (unknown version)                                                 
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] * matplotlib.sphinxext.plot_directive (3.10.1)                                                          
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] * jupyter_sphinx (0.5.3)                                                                                
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] Traceback                                                                                               
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] =========                                                                                               
[sagemath_doc_pdf-none] [spkg-install] [tutorial ]       File "/home/release/Sage/local/var/lib/sage/venv-python3.12.5/lib/python3.12/site-packages/jupyter
_sphinx/utils.py", line 15, in blank_nb                                                                                                                    
[sagemath_doc_pdf-none] [spkg-install] [tutorial ]         raise ExtensionError("Unable to find kernel", orig_exc=e)                                       
[sagemath_doc_pdf-none] [spkg-install] [tutorial ]     sphinx.errors.ExtensionError: Unable to find kernel (exception: No such kernel named sagemath)      
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] The full traceback has been saved in:                                                               
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] /tmp/sphinx-err-nfz9tecj.log                                                                        
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/is
sues/>. Thanks!                      
[sagemath_doc_pdf-none] [spkg-install] [tutorial ] Please also report this if it was a user error, so that a better error message can be provided next time
.                                     
[sagemath_doc_pdf-none] [spkg-install] LaTeX files can be found in /home/release/Sage/local/share/doc/sage/latex/en/tutorial.
[sagemath_doc_pdf-none] [spkg-install] make[5]: *** No rule to make target 'all-pdf'.  Stop.                                                               
[sagemath_doc_pdf-none] [spkg-install] Error building the documentation.                                                                                   
[sagemath_doc_pdf-none] [spkg-install] Traceback (most recent call last):                                                                                  
[sagemath_doc_pdf-none] [spkg-install]   File "<frozen runpy>", line 198, in _run_module_as_main
[sagemath_doc_pdf-none] [spkg-install]   File "<frozen runpy>", line 88, in _run_code                                                                      
[sagemath_doc_pdf-none] [spkg-install]   File "/home/release/Sage/src/sage_docbuild/__main__.py", line 552, in <module>
[sagemath_doc_pdf-none] [spkg-install]     sys.exit(main())                                                                                                
[sagemath_doc_pdf-none] [spkg-install]              ^^^^^^                                                                                                 
[sagemath_doc_pdf-none] [spkg-install]   File "/home/release/Sage/src/sage_docbuild/__main__.py", line 548, in main
[sagemath_doc_pdf-none] [spkg-install]     build()                                                                                                         
[sagemath_doc_pdf-none] [spkg-install]   File "/home/release/Sage/src/sage_docbuild/builders.py", line 273, in pdf
[sagemath_doc_pdf-none] [spkg-install]     raise RuntimeError(error_message % (command, tex_dir))
[sagemath_doc_pdf-none] [spkg-install] RuntimeError: failed to run $MAKE all-pdf in /home/release/Sage/local/share/doc/sage/latex/en/tutorial              

The problem is because sage-python was replaced with python3 which can run the ambient python, not the python from the venv where jupyter is installed:

$ git blame src/bin/sage
[...]
fc9b96ff53f7 (Kwankyu Lee         2022-07-08 09:42:37 +0900 1013)     # cause the build to hang. If stdin is /dev/null, TeX just aborts.
97d834b7779b (Tobias Diez         2025-07-27 22:11:07 +0200 1014)     exec python3 -m sage_docbuild "$@" </dev/null
e266569e4f42 (Kwankyu Lee         2022-07-07 16:24:20 +0900 1015) fi

Steps To Reproduce

No response

Config log

Default

Package logs

No response

Additional Information

No response

Checklist

  • I have searched the existing issues for a bug report that matches the one I want to file, without success.
  • I have read the documentation and troubleshoot guide

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions