[pypy-svn] r28950 - pypy/dist/pypy/doc

[arigo at codespeak.net]

Author: arigo
Date: Mon Jun 19 16:38:26 2006
New Revision: 28950

Modified:
   pypy/dist/pypy/doc/index.txt
   pypy/dist/pypy/doc/parser.txt
Log:
(cfbolz, arigo)

Grouped the entries of index.txt by theme.


Modified: pypy/dist/pypy/doc/index.txt
==============================================================================
--- pypy/dist/pypy/doc/index.txt	(original)
+++ pypy/dist/pypy/doc/index.txt	Mon Jun 19 16:38:26 2006
@@ -4,14 +4,14 @@
 
 .. _Python: http://www.python.org/dev/doc/maint24/ref/ref.html
 
-architecture_ gives a complete view of PyPy's basic design. 
+.. sectnum::
+.. contents::
 
-`getting started`_ provides hands-on instructions 
-including a two-liner to run PyPy on your system. 
 
-`coding guide`_ helps you to write code for PyPy. 
+PyPy documentation
+===============================================
 
-`development methodology`_ describe our sprint-driven approach. 
+architecture_ gives a complete view of PyPy's basic design. 
 
 `object spaces`_ discusses the object space interface 
 and several implementations. 
@@ -22,9 +22,6 @@
 `translation`_ offers the beginnings of documentation 
 about our low level code generator backends. 
 
-`EU reports`_ is a page that contains links to the
-preliminary reports that we submitted to the European Union.
-
 `dynamic-language translation`_ is a paper that describes
 the translation process, especially the flow object space
 and the annotator in detail. This document is also part
@@ -38,24 +35,47 @@
 properties into our interpreter during the translation
 process. This document is also part of the `EU reports`_.
 
-`parser`_ contains the beginnings of documentation about
-the parser (and the compiler at some point). 
+`parser`_ contains (outdated, unfinished) documentation about
+the parser.
 
 `garbage collection`_ contains documentation about
 garbage collection in PyPy.
 
-`FAQ`_ contains the beginning of frequently asked questions.
-Right now it's a bit empty.
+`EU reports`_ is a page that contains links to the
+preliminary reports that we submitted to the European Union.
+
+
+Meta-documentation
+=====================================
+
+`getting started`_ provides hands-on instructions 
+including a two-liner to run PyPy on your system. 
+
+`coding guide`_ helps you to write code for PyPy. 
+
+`development methodology`_ describe our sprint-driven approach. 
 
 `talks and related projects`_ lists presentations 
 and related projects. 
 
+`license`_ contains licensing details (basically a straight MIT-license). 
+
+`FAQ`_ contains the beginning of frequently asked questions.
+Right now it's a bit empty.
+
+
+Status
+======================================
+
+`PyPy's own tests`_, daily updated.
+
+`Nightly builds and benchmarks`_ of PyPy to C and LLVM.
+
 `compliance test status`_ shows outcomes of 
 recent compliance test runs against PyPy. 
 
 `PyPy statistics`_ shows LOC statistics about PyPy. 
 
-`license`_ contains licensing details (basically a straight MIT-license). 
 
 .. _`FAQ`: faq.html
 .. _parser: parser.html
@@ -77,6 +97,8 @@
 .. _`bytecode interpreter`: interpreter.html 
 .. _`EU reports`: index-report.html
 .. _`garbage collection`: garbage_collection.html
+.. _`PyPy's own tests`: http://snake.cs.uni-duesseldorf.de/pypytest/summary.html
+.. _`Nightly builds and benchmarks`: http://snake.cs.uni-duesseldorf.de/pypytest/benchmark.html
 .. _`directory reference`: 
 
 PyPy directory cross-reference 

Modified: pypy/dist/pypy/doc/parser.txt
==============================================================================
--- pypy/dist/pypy/doc/parser.txt	(original)
+++ pypy/dist/pypy/doc/parser.txt	Mon Jun 19 16:38:26 2006
@@ -3,7 +3,9 @@
 PyPy Parser 
 ==================
 
-[XXX: finish this document]
+WARNING: this document is out-of-date and unfinished.  Our compiler
+is done by now, unlike explained below.
+
 
 Overview
 ========