Clear message

Some tips and tricks about the documentation system

I've add 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...

• Why was it decided to switch ?

• The new format of doc is called reStructuredText it is hosted on sourceforge at ReST.

• For the impatient the following quickref gives a not so short description of the format.

• Here are the step if you want to rebuild the doc at home: First issue a

   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...