Another drawback of linking to online documentation is that the online documentation is always for the current release version of Sage, not the Sage that the user happens to be running,.
I have a suggestion to improve the situation, which is to do what the Sage_macOS app does. The app provides access to a local copy of the documentation stored inside the application bundle. The files are reorganized slightly to remove duplication and then compressed with gzip. The app views the files using cocoserver <https://pypi.org/project/cocoserver/>, which provides a slightly modfiied subclass of Python's ThreadingHTTPServer. The behavior of that server is modified so that it adds a gzip header to any file named *.gz. The browser automatically decompresses gzipped files served with such a header. ("Coco" stands for "compressed content".) Compressing the documentation reduces the size (of the English documentation) from about 600 GB to about 100 GB. The app also makes some small changes to the files __main__.py and kernel.py in sage/repl/ipython_kernel to make jupyter add options to its Help menu for viewing the Sage documentation. - Marc On Tuesday, April 9, 2024 at 4:52:23 PM UTC-5 Kwankyu Lee wrote: > On Wednesday, April 10, 2024 at 1:30:21 AM UTC+9 Denis wrote: > > At some point the help menu in jupyter notebooks started pointing to > doc.sagemath.org instead of the locally built documentation. I wouldn't > mind having a configuration option not to build the documentation, in which > case, of course, this would be expected. However, because the documentation > is still built by default, it looks more like a bug than a feature. Any > thoughts? > > > That was done because jupyterlab help menu does not support loading local > documentation. > > See https://github.com/sagemath/sage/pull/36246 > > Any idea to improve the situation? > -- 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/cee02859-39d1-473d-8ae3-f2c9984b8652n%40googlegroups.com.
