Fix docbuilding on release tag #40379

tobiasdiez · 2025-07-06T17:07:07Z

After #39973, some necessary steps during the docbuild on release tags are no longer run (see https://github.com/sagemath/sage/actions/runs/16100707903/job/45429461356). Sorry - that was my fault. This is fixed here.

Test run: https://github.com/tobiasdiez/sage/actions/runs/16323033505/job/46105684396

📝 Checklist

The title is concise and informative.
The description explains in detail what this PR is about.
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

Update conda environment to include rpy2 #40383

… build" This reverts commit 90392d8.

user202729 · 2025-07-14T15:00:32Z

do try to open a pull request on your repository to see that the diff is correctly processed.

tobiasdiez · 2025-07-16T14:58:30Z

It randomly fails with

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/sage/repl/ipython_kernel/__main__.py", line 4, in <module>
    IPKernelApp.launch_instance(kernel_class=SageKernel)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/traitlets/config/application.py", line 1074, in launch_instance
    app.initialize(argv)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/traitlets/config/application.py", line 118, in inner
    return method(app, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/ipykernel/kernelapp.py", line 692, in initialize
    self.init_sockets()
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/ipykernel/kernelapp.py", line 336, in init_sockets
    self.stdin_port = self._bind_socket(self.stdin_socket, self.stdin_port)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/ipykernel/kernelapp.py", line 253, in _bind_socket
    return self._try_bind_socket(s, port)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/ipykernel/kernelapp.py", line 229, in _try_bind_socket
    s.bind("tcp://%s:%i" % (self.ip, port))
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/zmq/sugar/socket.py", line 320, in bind
    super().bind(addr)
  File "zmq/backend/cython/_zmq.py", line 998, in zmq.backend.cython._zmq.Socket.bind
    _check_rc(rc)
  File "zmq/backend/cython/_zmq.py", line 187, in zmq.backend.cython._zmq._check_rc
    raise ZMQError(errno)
zmq.error.ZMQError: Address already in use (addr='tcp://127.0.0.1:39085')
[rings_num] Extension error!
[rings_num] Versions
[rings_num] ========
[rings_num] * Platform:         linux; (Linux-6.11.0-1015-azure-x86_64-with-glibc2.39)
[rings_num] * Python version:   3.11.13 (CPython)
[rings_num] * Sphinx version:   8.2.3
[rings_num] * Docutils version: 0.21.2
[rings_num] * Jinja2 version:   3.1.6
[rings_num] * Pygments version: 2.19.2
[rings_num] Last Messages
[rings_num] =============
[rings_num]     sage/rings/real_mpfi
[rings_num]     sage/rings/real_mpfr
[rings_num] Loaded Extensions
[rings_num] =================
[rings_num] * sphinx.ext.mathjax (8.2.3)
[rings_num] * alabaster (1.0.0)
[rings_num] * sphinxcontrib.applehelp (2.0.0)
[rings_num] * sphinxcontrib.devhelp (2.0.0)
[rings_num] * sphinxcontrib.htmlhelp (2.1.0)
[rings_num] * sphinxcontrib.serializinghtml (1.1.10)
[rings_num] * sphinxcontrib.qthelp (2.0.0)
[rings_num] * sage_docbuild.ext.inventory_builder (unknown version)
[rings_num] * sage_docbuild.ext.multidocs (unknown version)
[rings_num] * sphinx.ext.autodoc.preserve_defaults (8.2.3)
[rings_num] * sphinx.ext.autodoc.type_comment (8.2.3)
[rings_num] * sphinx.ext.autodoc.typehints (8.2.3)
[rings_num] * sage_docbuild.ext.sage_autodoc (8.2.3)
[rings_num] * sphinx.ext.todo (8.2.3)
[rings_num] * sphinx.ext.extlinks (8.2.3)
[rings_num] * sphinx.ext.linkcode (8.2.3)
[rings_num] * sphinx_copybutton (0.5.2)
[rings_num] * sphinx_inline_tabs (2023.04.21)
[rings_num] * IPython.sphinxext.ipython_directive (unknown version)
[rings_num] * matplotlib.sphinxext.plot_directive (3.10.3)
[rings_num] * jupyter_sphinx (0.5.3)
[rings_num] Traceback
[rings_num] =========
[rings_num]       File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/jupyter_sphinx/execute.py", line 294, in execute_cells
[rings_num]         raise ExtensionError("Notebook execution failed", orig_exc=e)
[rings_num]     sphinx.errors.ExtensionError: Notebook execution failed (exception: Kernel died before replying to kernel_info)
[rings_num] The full traceback has been saved in:
[rings_num] /tmp/sphinx-err-g4ve6eml.log
[rings_num] To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
[rings_num] Please also report this if it was a user error, so that a better error message can be provided next time.
Exception ignored in atexit callback: <bound method run_sync.<locals>.wrapped of <nbclient.client.NotebookClient object at 0x7fcd3e18d690>>
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/jupyter_core/utils/__init__.py", line 158, in wrapped
    return loop.run_until_complete(inner)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/asyncio/base_events.py", line 654, in run_until_complete
    return future.result()
           ^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.11/site-packages/nbclient/client.py", line 504, in _async_cleanup_kernel
    assert self.km is not None
           ^^^^^^^^^^^^^^^^^^^
AssertionError:

in the 'livedoc' building. I don't have time right now to investigate this further and thus temporarily disabled the live doc building.

https://github.com/tobiasdiez/sage/actions/runs/16137723269

user202729 · 2025-07-16T17:07:30Z

I guess if it works sometimes it's still better than it fails all of the time (?)

tobiasdiez · 2025-07-16T18:33:12Z

I run it a couple of times, and it was always failing - but the "sub-docs" that triggered this error was always different.

user202729 · 2025-07-17T00:20:46Z

Address already in use

Maybe try disabling parallelism? (Better slow than broken?)

tobiasdiez · 2025-07-17T11:57:34Z

Sure, that's a good approach to fix it. I don't have the time to work on this in the next two weeks (and this PR was meant more as quick hotfix), but will investigate it more afterwards...

tobiasdiez · 2025-07-21T09:22:23Z

The live docs issue is tracked at #40463. Could we please get this is to have the docbuild run in GH finally pass again?

dimpase · 2025-07-21T13:06:34Z

I wish these long generated yml files are not getting in the way, but OK.

user202729 · 2025-07-21T13:35:16Z

What does livedoc mean? Besides, what is the effect of this pull request?

https://doc-release--sagemath.netlify.app/html/en/ gets rebuilt each time?
the GitHub-action bot posts a message "documentation preview is ready!" on each pull request?

…lease

tobiasdiez · 2025-07-24T19:11:04Z

What does livedoc mean?

That's a mode where you can edit the example in the browser and rerun it, see the "Sage Live" tab on https://doc-release--sagemath.netlify.app/html/en/a_tour_of_sage/. This is not used (yet?) on the official sage website.

Besides, what is the effect of this pull request?

It fixes the doc build action run that is triggered after a new release (and such a successful run is needed to have the docbuild runs for PRs succeed).

--

@dimpase Thanks for the review.

I've now merged #40383 (and rerun update-conda) into this branch to prevent merge conflicts. Will set back to positive review after the CI is green.

For later reference, updating the compilers needs new givaro and for this first conda-forge/fflas-ffpack-feedstock#21.

dimpase · 2025-07-24T19:50:22Z

updating compilers?

tobiasdiez · 2025-07-24T20:05:39Z

updating compilers?

In conda, gcc v14 is not working (due to some issues in givaro 4.2.0; 4.2.1 is already on conda but then there are issues with fflas conda-forge/fflas-ffpack-feedstock#21). Sage-the-distro is not affected.

user202729 · 2025-07-24T20:15:41Z

can you merge this into develop of your fork and open a pull request in https://github.com/tobiasdiez/sage/pulls just to double check that the doc is correctly built?

sagemathgh-40379: Fix docbuilding on release tag       After sagemath#39973, some necessary steps during the docbuild on release tags are no longer run (see https://github.com/sagemath/sage/actions/runs/161 00707903/job/45429461356). Sorry - that was my fault. This is fixed here. Test run: https://github.com/tobiasdiez/sage/actions/runs/16323033505/jo b/46105684396 ### 📝 Checklist  - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] 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    - sagemath#40383 URL: sagemath#40379 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik

tobiasdiez added 2 commits July 6, 2025 19:06

Fix docbuilding on release tag

f83b669

Create docs folder if not present

720fca0

github-actions bot added the s: needs review label Jul 6, 2025

tobiasdiez added 6 commits July 7, 2025 01:05

Add jupyter-sphinx to conda environnement

a4263a8

Update conda environment to include rpy2

d213ca2

Don't use editable build for docbuild

7d62a8a

Remove sage src directory to avoid shadowing conflicts during build

90392d8

Revert "Remove sage src directory to avoid shadowing conflicts during…

0e510fe

… build" This reverts commit 90392d8.

Add sys.path manipulation to fix shadowing of installed sage

f59a6fd

tobiasdiez force-pushed the fix-docbuilding-release branch from cc5dfd4 to f59a6fd Compare July 7, 2025 10:35

Fix copying of livedoc

caac4a8

tobiasdiez mentioned this pull request Jul 8, 2025

Migrate CI build-doc to Meson #39973

Merged

5 tasks

antonio-rojas added the p: blocker / 1 label Jul 11, 2025

Comment out live documentation build and deployment steps in workflows

07397ef

user202729 mentioned this pull request Jul 20, 2025

gcd and lcm of isogenies of Drinfeld modules #40434

Open

5 tasks

tobiasdiez mentioned this pull request Jul 21, 2025

Use meson in sage-the-distro #39030

Open

5 tasks

tobiasdiez requested a review from dimpase July 21, 2025 09:20

tobiasdiez mentioned this pull request Jul 21, 2025

Reenable live docs #40463

Open

dimpase approved these changes Jul 21, 2025

View reviewed changes

dimpase added s: positive review and removed s: needs review labels Jul 21, 2025

Merge remote-tracking branch 'origin/r-conda' into fix-docbuilding-re…

28409f7

…lease

github-actions bot added s: needs review and removed s: positive review labels Jul 24, 2025

Downgrade compiler versions to fix compilation

109a1e1

dimpase added s: positive review and removed s: needs review labels Jul 24, 2025

vbraun merged commit 98e19c1 into sagemath:develop Aug 2, 2025
22 of 23 checks passed

github-actions bot removed the s: positive review label Aug 2, 2025

kwankyu mentioned this pull request Aug 15, 2025

Revive doc-release #40586

Open

5 tasks

user202729 mentioned this pull request Aug 16, 2025

Remove spurious diffs in doc previews #40595

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix docbuilding on release tag #40379

Fix docbuilding on release tag #40379

Uh oh!

tobiasdiez commented Jul 6, 2025 •

edited

Loading

Uh oh!

user202729 commented Jul 14, 2025

Uh oh!

tobiasdiez commented Jul 16, 2025 •

edited

Loading

Uh oh!

user202729 commented Jul 16, 2025

Uh oh!

tobiasdiez commented Jul 16, 2025

Uh oh!

user202729 commented Jul 17, 2025

Uh oh!

tobiasdiez commented Jul 17, 2025

Uh oh!

tobiasdiez commented Jul 21, 2025

Uh oh!

dimpase commented Jul 21, 2025

Uh oh!

user202729 commented Jul 21, 2025

Uh oh!

tobiasdiez commented Jul 24, 2025

Uh oh!

dimpase commented Jul 24, 2025

Uh oh!

tobiasdiez commented Jul 24, 2025 •

edited

Loading

Uh oh!

user202729 commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fix docbuilding on release tag #40379

Fix docbuilding on release tag #40379

Uh oh!

Conversation

tobiasdiez commented Jul 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Checklist

⌛ Dependencies

Uh oh!

user202729 commented Jul 14, 2025

Uh oh!

tobiasdiez commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

user202729 commented Jul 16, 2025

Uh oh!

tobiasdiez commented Jul 16, 2025

Uh oh!

user202729 commented Jul 17, 2025

Uh oh!

tobiasdiez commented Jul 17, 2025

Uh oh!

tobiasdiez commented Jul 21, 2025

Uh oh!

dimpase commented Jul 21, 2025

Uh oh!

user202729 commented Jul 21, 2025

Uh oh!

tobiasdiez commented Jul 24, 2025

Uh oh!

dimpase commented Jul 24, 2025

Uh oh!

tobiasdiez commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

user202729 commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

tobiasdiez commented Jul 6, 2025 •

edited

Loading

tobiasdiez commented Jul 16, 2025 •

edited

Loading

tobiasdiez commented Jul 24, 2025 •

edited

Loading