Hi folks, I thought I should provide an update about my proposal [1] to include the following in the Sage standard documentation:
* FAQ * Python Functional Programming for Mathematicians * Sage and Coding Theory * Sage and Cython: A Brief Introduction * Linear Programming in Sage * Group Theory and Sage: A Primer * Number Theory and the RSA Public Key Cryptosystem Here is a list of all documents I have ReSTified so far, together with the corresponding ticket numbers: #8464 add FAQ to standard documentation #8465 Functional Programming for Mathematicians #8469 Number Theory and the RSA Public Key Cryptosystem #8468 Group Theory and Sage These tickets have patches awaiting review. After applying the relevant patches at those tickets and rebuilding the whole Sage standard documentation, you would get something like what is available at http://sage.math.washington.edu/home/mvngu/8470-newdoc/ Note that the following has a patch #8442 Lie Methods and Related Combinatorics but I think it needs to be rebased to take account of the new documentation category "Thematic Tutorials". When you visit the new documentation at the above URL, be sure to look through the reference manual. I have configured its table of contents to be of depth 1. This means that you now only see top-level topic headings, but not subheadings as is currently the case with the reference manual [2]. In a thread on sage-devel [3], Jason Bandlow suggested that the TOC depth be set to 1. To get a feel for how this would affect the look of the reference manual, it might be worth comparing this new reference manual with TOC depth 1 to the current reference manual on the Sage website. If we are going to have the reference manual configured to TOC depth 1, I think it requires a vote. In ReSTifying tutorials for the category "Thematic Tutorials", I configured the docbuilder for this new documentation category to print the author names. So on each document in "Thematic Tutorials", you now see the name of the corresponding author. I hope this would make it clear who the document authors are and how to contact them about new additions and updates. Nicolas Thiéry recently suggested that each module in the Sage library be accompanied by a corresponding tutorial and possibly a primer as well. So for example, one would have sage/combinat/tutorial sage/groups/tutorial sage/calculus/tutorial and so on. From the command line, one could do sage.groups.tutorial? and hit the enter key to read the group theory tutorial from the command line, or do the same thing from within the notebook interface. I tried to achieve this, but failed. Here is what happened. To do sage.groups.tutorial? and read the group theory tutorial, I tried ReSTifying Rob Beezer's tutorial at #8468 and make it into a docstring, pretending that the whole tutorial is a docstring for a Python module named sage/groups/tutorial.py I then edited the file sage/all.py to insert the line import sage.groups.tutorial The effect was that you could do as above to read the group theory tutorial from the command line. However, I was then stuck on how to list this tutorial on the page for the thematic tutorials. In the end, I just put Rob's tutorial under the directory thematic_tutorials/ instead of under sage/groups/. [1] http://groups.google.com/group/sage-devel/browse_thread/thread/95afb345e872f9af [2] http://www.sagemath.org/doc/reference/ [3] http://groups.google.com/group/sage-devel/browse_thread/thread/e94b8f3dc6f503af -- Regards Minh Van Nguyen -- To post to this group, send an email to sage-devel@googlegroups.com To unsubscribe from this group, send an email to sage-devel+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
