|
Size: 1183
Comment: Added Tips & Tricks about the doc.
|
← Revision 26 as of 2022-04-07 01:08:53 ⇥
Size: 0
Comment: all of this is covered by https://doc.sagemath.org/html/en/developer/sage_manuals.html
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = 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 [[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]]. * For the impatient the following [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|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... |
