Some tips and tricks about the documentation system

I had some trouble to use the new documentation system. I'm putting here some tips and tricks. For now on, it's only my "experience returns" so that this may not be the right way to do. Please expand and correct...

1. For the impatient

The two most important things to know are

2. Quick ref of the format

The link quickref gives a not so short description of the format.

3. Step by step instruction for building the doc

sage -b

to make sure that the sage is up-to-date with your modifications. Then depending of the desired format you call

sage -docbuild reference <format>

For example, I use the html format so that I call

sage -b && sage -docbuild reference html

Then the compiled doc is found at

$SAGE_ROOT/devel/sage/doc/output/html/en/reference/index.html

You can use you browser to view it...

4. Getting help on the docbuild system

sage -docbuild -help

explains all the sage -docbuild options.

5. How to find the unincluded docs ?

You can generate such the list by:

sage -docbuild reference print_unincluded_modules

6. Do you want to know more ?

7. Trouble shooting

File "/home/combi/hivert/Sage/sage-3.4/local/lib/python2.5/subprocess.py", line 1003, in _execute_child
    errpipe_read, errpipe_write = os.pipe()
OSError: [Errno 24] Too many open files
The full traceback has been saved in /tmp/sphinx-err--kaK6F.log, if you want to report the issue to the author.
Please also report this if it was a user error, so that a better error message can be provided next time.
Send reports to [email protected]. Thanks!
Build finished.  The built documents can be found in /home/combi/hivert/Sage/sage/devel/sage/doc/output/html/en/reference

I don't understand why but I nevertheless managed to build the doc using jsmath

sage -docbuild --jsmath all html