On Tuesday, August 20, 2024 at 6:45:41 AM UTC-7 Kwankyu Lee wrote:

On Tuesday, August 20, 2024 at 7:07:54 PM UTC+9 Eric Gourgoulhon wrote:

There are tons of png files in the "3d Graphics" section of the 
documentation:  
https://doc.sagemath.org/html/en/reference/plot3d/sage/plot/plot3d/plot3d.html
It would be quite a burden to maintain this manually. 


Meanwhile I looked into the responsible code and studied how Jmol/Tachyon 
is used in rendering images from 3d graphics via sphinx_plot() via ".. 
PLOT::"

As generating these images is already automated, I would not advocate for 
switching to a manual way. Moreover, I now see that the automated way helps 
in keeping the documentation source small (while compiling the 
documentation takes longer).

I just want to note that maintaining png files is no burden once added 
(either manually or in bulk using playwright) as the documentation rarely 
changes.


I just built Sage on an OS X machine with a bunch of homebrew packages 
installed. It took under 20 minutes to build everything except the 
documentation, while the file sagemath_doc_html-none.time says

real 24m20.264s
user 34m51.512s
sys 9m1.973s

Oh, and this is with "SAGE_DOCBUILD_OPTS=' --no-plot'". If the 
documentation is taking longer than everything else combined, maybe we 
should consider distributing all of the documentation pre-built as a 
tarball, not just some png files. (I have resisted this in the past, but I 
am changing my mind.) Packages that are necessary to build the 
documentation could be "optional," or there could be a new type for them. 
The standard "make" would use the pre-built tarball, while another "make" 
target could build the documentation from scratch. This could make the 
build process faster with fewer associated standard packages.

 

 

The drawback of Jmol-generated png files is that they do not exactly 
correspond to what the user gets on his/her screen in a Jupyter notebook 
with the default viewer (threejs). 


I agree. Manually-generated images have the same benefit :-)

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sage-devel/c27f4bac-90d9-46a8-90ff-6f084c162acen%40googlegroups.com.

Reply via email to