|
Size: 4283
Comment:
|
← 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 had some trouble to use the new documentation system. I'm putting here some tips and tricks. This page was build by gathering informations from the mailing list and irc. This may not be the right way to do. Please expand and correct... ---- === For the impatient === The two most important things to know are * {{{``inline literal``}}} for sage raw code * {{{`LaTeX interpreted text`}}} for mathematics * Any line ending with {{{::}}} means that the following indented things are a literal block (usually {{{sage: commands}}}) ---- === The ReST Format === The link [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|quickref]] gives a not so short description of the format ---- === Step by step instruction for building the doc === * 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... * You can get some help on the docbuild system by: {{{ sage -docbuild -help }}} explains all the {{{sage -docbuild}}} options. ---- === Adding a new file to the doc === If you write a new file say {{{sage/combinat/family.py}}} and you want your doc to be added to the system you have to add your file in the relevant {{{index.rst}}} file usually located in the tree: {{{ $SAGE_ROOT/devel/sage-combinat/doc/en/reference }}} Going back to my example I have to add to {{{ $SAGE_ROOT/devel/sage-combinat/doc/en/reference/combinat/index.rst }}} The following lines {{{ Combinatorics ============= .. toctree:: :maxdepth: 2 ../sage/combinat/combinat [...] ../sage/combinat/dyck_word + ../sage/combinat/family ../sage/combinat/finite_class [...] }}} ---- === How to find the unincluded docs ? === You can generate such the list by: {{{ sage -docbuild reference print_unincluded_modules }}} ---- ---- == 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]]. ---- ---- == Trouble shooting == * On a machine I got the following error: {{{ 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 }}} ---- === If you have deleted some doc file === Suppose that you added your file to some {{{index.rst}}} and then you delete it (e.g. by unapplying some patch). This cause some trouble because the build system left some garbage. Here there after unapplying the patch the file {{{enumerated_sets.py}}} does not exists anymore: {{{ OSError: [Errno 2] No such file or directory: '/usr/local/sage/sage-3.4/devel/sage-combinat/doc/en/reference/sage/categories/enumerated_sets.rst' }}} Right now I don't know a good fix. Here are the methods I use: * Delete all the copy of {{{enumerated_sets.py}}} and {{{enumerated_sets.pyc}}} at the various positions of {{{$SAGE_ROOT/devel/sage/build}}} * Delete the {{{enumerated_sets.rst}}} file If this still not work you can simply * Nuke the whole {{{$SAGE_ROOT/devel/sage/doc/output}}} tree ! ---- Have a nice doc !!! |
