Hello all, As part of the conversion of the Sage documentation to Sphinx, I propose that Sphinx and its dependencies (Docutils, Pygments, and Jinja) be added to Sage. Here are brief descriptions for what each of the packages does:
* Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. * Docutils is a modular system for processing documentation into useful formats, such as HTML, XML, and LaTeX. For input Docutils supports reStructuredText, an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax. * Pygments is a syntax highlighting package written in Python. It is a generic syntax highlighter for general use in all kinds of software such as forum systems, wikis or other applications that need to prettify source code. Highlights are: a wide range of common languages and markup formats is supported, special attention is paid to details, increasing quality by a fair amount, support for new languages and formats are added easily, a number of output formats, presently HTML, LaTeX, RTF, SVG and ANSI sequences, it is usable as a command-line tool and as a library. * Jinja is a sandboxed template engine written in pure Python. It provides a Django like non-XML syntax and compiles templates into executable python code. It's basically a combination of Django templates and python code. While all of the above are required for Sphinx, some of them also provide other advantages to Sage. For example, pygments can be used to provide syntax highlighting in trac, the wiki, and the Mercurial code browser. Docutils would allow one to use reStructuredText within the wiki. The Jinja templating system would be very useful in the notebook to help separate the HTML / CSS / Javascript from the Python code and provide greater consistency and extensibility though things like internationalization of the templates. All of the above are released under the modified BSD license and are pure Python packages which should be trivially portable to any of Sage's target platforms. Spkgs for all of the above can be found at http://sage.math.washington.edu/home/mhansen/doc-sphinx/ . The order they should be installed in is setuptools, pygments, docutils, jinja, and sphinx. VOTE: [ ] Yes, include these in Sage [ ] No, do not (please explain) [ ] Hmm, I have questions (please ask). Thanks, Mike --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
