Ask Your Question
0

manifolds docs

asked 2023-10-02 22:45:11 +0100

murraye gravatar image

updated 2023-10-02 23:05:55 +0100

I installed SageMath 10.1 from https://sagemanifolds.obspm.fr/downlo....

At that page:

(1) it is alleged that the reference manuals for Manifolds are at:

local/share/doc/sage/html/en/reference/manifolds/index.html

and

local/share/doc/sage/html/en/reference/index.html

but I find no such files. Where, exactly, is that "local" directory supposed to be located in the macOS tree?

(2) it is alleged that one can generate PDF versions of the reference manuals by:

`./sage -docbuild reference/manifolds pdf`

./sage -docbuild reference/tensor_free_modules pdf

Those commands do not work. First, what directory should I be in to find the sage command?

Second, note that the sage executable is already on my path, but each of the commands

 sage -docbuild reference/manifolds pdf
 sage -docbuild reference/tensor_free_modules pdf

gives a FileNotFoundError, specifically:

No such file or directory: '/Applications/SageMath-10-1.app/Contents/Frameworks/Sage.framework/Versions/10.1/src/doc'

edit retag flag offensive close merge delete

2 Answers

Sort by ยป oldest newest most voted
1

answered 2023-10-03 19:57:19 +0100

The Mac App includes some changes to the regular Sage installation, and I think the documentation is not up to date. First, a good way to access the documentation is from the Sage website: https://www.sagemath.org/help.html, and in particular https://doc.sagemath.org/html/en/refe... for manifolds in particular. Another way to access it is, while running Sage, use the command reference() to open the Reference manual. From the Jupyter notebook, you can also use the "Help" menu. (With the Mac App, the documentation is available at /Applications/SageMath-10-1.app/Contents/Resources/documentation/, but all of the html files are compressed.)

To access the PDF documentation, probably the easiest way is again through the SageMath website: https://doc.sagemath.org/pdf/en/refer... and https://doc.sagemath.org/pdf/en/refer..., for example. Unless you're planning to change the code and then rebuild the documentation, this is probably the best choice. If you are planning to change the code and rebuild the documentation, you should instead be building Sage from scratch, in which case you should follow the installation guide.

edit flag offensive delete link more
1

answered 2023-10-03 12:00:24 +0100

eric_g gravatar image

Regarding question (1), the local directory is a subdirectory of your Sage root directory. The latter is returned when typing

!sage -root

in a Sage session (either in a Sage console or in a Jupyter notebook).

I am sorry I cannot answer question (2) for I am not a macOS user.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower

Stats

Asked: 2023-10-02 22:45:11 +0100

Seen: 200 times

Last updated: Oct 03 '23