-
-
Notifications
You must be signed in to change notification settings - Fork 452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sagemath_doc_html: Use jupyter-sphinx for 3D graphics #33507
Comments
This comment has been minimized.
This comment has been minimized.
comment:2
It uses nbsphinx: https://nbsphinx.readthedocs.io/en/0.8.8/ nbsphinx allows including jupyter notebooks in toctrees. It seems that we cannot include a single cell of a jupyter notebook as a part of our documentation, which I guess is what we want. |
Branch: public/33507 |
Commit: |
Branch pushed to git repo; I updated commit sha1. New commits:
|
Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:
|
comment:6
This tool https://jupyter-sphinx.readthedocs.io/en/latest/ works well. I uploaded a branch to experiment with the tool. First |
comment:7
This package would be easy to add, we already have all dependencies - https://github.com/jupyter/jupyter-sphinx/blob/master/setup.py#L30 |
Branch pushed to git repo; I updated commit sha1. New commits:
|
comment:10
We need a sagemath binder repo for Thebe to work. |
Branch pushed to git repo; I updated commit sha1. New commits:
|
comment:12
The last commit provides an example to provide live images to htmls and static images to pdfs. |
comment:13
One annoying thing is that |
Branch pushed to git repo; I updated commit sha1. New commits:
|
comment:16
Here's the package |
comment:17
Replying to @kwankyu:
I fixed 'Sage binder env' about a month ago: https://github.com/sagemath/sage-binder-env It now uses conda to install Sage which is more maintained than |
comment:18
Replying to @mkoeppe:
Thank you! |
comment:19
Replying to @nthiery:
I have no experience with Thebe. Jupyter-sphinx supports Thebe. But running an interact example cell through jupyter-sphinx only shows |
comment:74
Sorry, fixed now |
comment:75
I am still getting this docbuild error on macOS, even after
something in these two modules wants to call I presume the message "Notebook execution failed" comes from jupyter-sphinx: |
Changed reviewer from Matthias Koeppe, ... to Matthias Koeppe, Dima Pasechnik |
comment:76
after
the docbuild completes, but it's certainly a problem to be fixed that needs this workaround. |
comment:77
Replying to @dimpase:
...
I am on macOS too. Do you have no problem in running sagemath kernel in jupyter from your sage installation? |
comment:78
If I remove the symlink as in comment:76 I get a jupyter kernel error
With the link it works. It turns out I have outdated things in Sorry for noise, it's OK. |
comment:79
Probably the docbuild should try to isolate from such user settings. |
comment:80
Replying to @mkoeppe:
I don't understand the precise mechanism. But it seems that jupyter-sphinx just runs a new jupyter notebook with sagemath kernel. Then there is nothing to do with the docbuild. |
comment:81
Replying to @dimpase: Thank you for review. |
comment:82
Replying to @kwankyu:
But its happening during the docbuild according to the output that Dima shared |
comment:83
Replying to @mkoeppe:
The source of the problem may be in our jupyter kernel configuration in |
comment:84
Replying to @mkoeppe:
I could reproduce this issue just by running |
Changed branch from public/33507 to |
Changed commit from |
comment:86
The first bug report on this may have arrived: https://groups.google.com/g/sage-release/c/-0luW4DPEPs/m/1bST2lbcCAAJ |
comment:87
Replying to @mkoeppe:
You mean
I suppose. This looks identical to comment:75 - a stale Jupyter kernel somewhere. |
comment:88
Yes. I have opened #33650 for this. |
We use jupyter-sphinx
https://jupyter-sphinx.readthedocs.io/en/latest/
to facilitate live sage documentation based on jupyter and Thebe.
For documentation authors, new directives are available:
in addition to
See the branch for examples.
Related tickets: #31027
Depends on #33529
CC: @kwankyu @jhpalmieri @nthiery @egourgoulhon @dimpase
Component: documentation
Author: Kwankyu Lee, Matthias Koeppe
Branch:
72c8378
Reviewer: Matthias Koeppe, Dima Pasechnik
Issue created by migration from https://trac.sagemath.org/ticket/33507
The text was updated successfully, but these errors were encountered: