Differences between revisions 2 and 3
⇤ ← Revision 2 as of 2009-03-01 17:41:01 →
Size: 1222
Editor: FlorentHivert
Comment:
← Revision 3 as of 2009-03-12 23:53:27 → ⇥
Size: 1487
Editor: FlorentHivert
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from HelpOnTheDoc
Line 4: Line 3:
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... 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...
Line 6: Line 5:
 * Why was it decided to [[http://wiki.sagemath.org/SphinxSEP|switch]] ? == For the impatient ==
Line 8: Line 7:
 * The new format of doc is called {{{reStructuredText}}} it is hosted on sourceforge at [[http://docutils.sourceforge.net/rst.html|ReST]]. The two most important things to know are
 * {{{``inline literal``}}} for sage row code
 
 * {{{`LaTeX interpreted text`}}} for mathematics
Line 10: Line 12:
 * For the impatient the following [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|quickref]] gives a not so short description of the format.  * line Ending with {{{::}}} means that the following indented things are a literal block (usually {{{sage: commands}}}
 
The link [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|quickref]] gives a not so short description of the format.
Line 29: Line 33:

== Do you want to know more ? ==

 * Why was it decided to [[http://wiki.sagemath.org/SphinxSEP|switch]] ?

 * The new format of doc is called {{{reStructuredText}}} it is hosted on sourceforge at [[http://docutils.sourceforge.net/rst.html|ReST]].

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

  • ``inline literal`` for sage row code

  • `LaTeX interpreted text` for mathematics

  • line Ending with :: means that the following indented things are a literal block (usually sage: commands

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

2. Do you want to know more ?

  • Why was it decided to switch ?

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