[pypy-svn] pypy default: (dmalcolm, lac, necaris): First pass at categorizing the docs into an index

[dmalcolm]

Author: David Malcolm <dmalcolm at redhat.com>
Branch: 
Changeset: r42742:480a8afb911d
Date: 2011-03-14 13:27 -0400
http://bitbucket.org/pypy/pypy/changeset/480a8afb911d/

Log:	(dmalcolm, lac, necaris): First pass at categorizing the docs into
	an index

	The sphinx "make html" emits warnings for the comments, but they're
	non-fatal

diff --git a/pypy/doc/index.txt b/pypy/doc/index.txt
--- a/pypy/doc/index.txt
+++ b/pypy/doc/index.txt
@@ -11,18 +11,123 @@
 .. toctree::
    :maxdepth: 2
 
-   .. The following stuff has not yet been categorized:
+   .. STUFF THAT'S BEEN THROUGH 1ST PASS CATEGORIZATION:
+
+   .. The following stuff is high-value and (vaguely) true:
+   getting-started.txt
+   getting-started-python.txt
+   getting-started-dev.txt
+   faq.txt
+   architecture.txt
+   coding-guide.txt
+   cleanup-todo.txt
+   cpython_differences.txt
+   garbage_collection.txt
+   interpreter.txt
+   objspace.txt
+
+   dev_method.txt
+   download.txt
+   extending.txt
+   windows.txt
+
+   extradoc.txt
+     .. ^^ integrate this one level up: dcolish?
+
+   glossary.txt
+
+   contributor.txt
+
+   .. True, high-detail:
+   interpreter-optimizations.txt
+   configuration.txt
+   low-level-encapsulation.txt
+   parser.txt
+   rlib.txt
+   rtyper.txt
+   translation.txt
+   jit/_ref.txt
+   jit/index.txt
+   jit/overview.txt
+   jit/pyjitpl5.txt
+
+   ctypes-implementation.txt
+     .. ^^ needs attention
+
+   how-to-release.txt
+     .. ^^ needs attention
+
+   index-report.txt
+     .. ^^ of historic interest, and about EU fundraising
+
+   maemo.txt
+     .. ^^ obscure corner; not sure of status
+
+   stackless.txt
+     .. ^^ it still works; needs JIT integration; hasn't been maintained for years
+
+   .. The following stuff is good material relating to unmaintained areas of the project:
+      .. .Net stuff:
+   cli-backend.txt
+   clr-module.txt
+   carbonpython.txt
+
+   .. Release notes:
+   release-0.6.txt
+   release-0.7.0.txt
+   release-0.8.0.txt
+   release-0.9.0.txt
+   release-0.99.0.txt
+   release-1.0.0.txt
+   release-1.1.0.txt
+   release-1.2.0.txt
+   release-1.3.0.txt
+   release-1.4.0.txt
+   release-1.4.0beta.txt
+   release-1.4.1.txt
+
+
+   .. The following stuff is old (and crufty?), and needs further investigation:
+   buildtool.txt
+   distribution.txt
+   eventhistory.txt
+     .. ^^ Incomplete,  superceded elsewhere
+
+   externaltools.txt
+     .. ^^ Incomplete and wrong,  superceded elsewhere
+
+   geninterp.txt
+     .. ^^ apparently dead
+
+   objspace-proxies.txt
+
+   old_news.txt
+
+   sprint-reports.txt
+
+   project-ideas.txt
+
+   rffi.txt
 
    sandbox.txt
-   sprint-reports.txt
-   stackless.txt
+     .. ^^ it continues to work, but is unmaintained
+
    statistic/index.txt
+
+   theory.txt
+     .. ^^ old ideas; we're not doing it this way any more
+
+   translation-aspects.txt
+     .. ^^ old and needs updating
+
+   .. This needs merging somehow:
+   docindex.txt
+
+   .. Needs merging/replacing with hg stuff:
    svn-help.txt
-   theory.txt
-   translation.txt
-   translation-aspects.txt
-   video-index.txt
-   windows.txt
+
+   .. The following discussions have not yet been categorized:
+
    discussion/GC-performance.txt
    discussion/VM-integration.txt
    discussion/chained_getattr.txt
@@ -54,101 +159,8 @@
    discussion/translation-swamp.txt
    discussion/use_case_of_logic.txt
 
-
-
-   .. STUFF THAT'S BEEN DONE
-
-   .. This needs merging somehow:
-   docindex.txt
-
-   .. The following stuff is high-value and (vaguely) true:
-   getting-started.txt
-   getting-started-python.txt
-   getting-started-dev.txt
-   faq.txt
-   architecture.txt
-   coding-guide.txt
-   cleanup-todo.txt
-   cpython_differences.txt
-   garbage_collection.txt
-   interpreter.txt
-   objspace.txt
-
-   dev_method.txt
-   download.txt
-   extending.txt
-
-   extradoc.txt
-     .. ^^ integrate this one level up: dcolish?
-
-   glossary.txt
-
-   contributor.txt
-
-   .. True, high-detail:
-   interpreter-optimizations.txt
-   configuration.txt
-   low-level-encapsulation.txt
-   parser.txt
-   rlib.txt
-   rtyper.txt
-   jit/_ref.txt
-   jit/index.txt
-   jit/overview.txt
-   jit/pyjitpl5.txt
-
-   ctypes-implementation.txt
-     .. ^^ needs attention
-
-   how-to-release.txt
-     .. ^^ needs attention
-
-   index-report.txt
-     .. ^^ of historic interest, and about EU fundraising
-
-   maemo.txt
-     .. ^^ obscure corner; not sure of status
-
-   .. The following stuff is good material relating to unmaintained areas of the project:
-      .. .Net stuff:
-   cli-backend.txt
-   clr-module.txt
-   carbonpython.txt
-
-   .. Release notes:
-   release-0.6.txt
-   release-0.7.0.txt
-   release-0.8.0.txt
-   release-0.9.0.txt
-   release-0.99.0.txt
-   release-1.0.0.txt
-   release-1.1.0.txt
-   release-1.2.0.txt
-   release-1.3.0.txt
-   release-1.4.0.txt
-   release-1.4.0beta.txt
-   release-1.4.1.txt
-
-
-   .. The following stuff is old (and crufty?), and needs further investigation:
-   buildtool.txt
-   distribution.txt
-   eventhistory.txt
-     .. ^^ Incomplete,  superceded elsewhere
-
-   externaltools.txt
-     .. ^^ Incomplete and wrong,  superceded elsewhere
-
-   geninterp.txt
-     .. ^^ apparently dead
-
-   objspace-proxies.txt
-
-   old_news.txt
-
-   project-ideas.txt
-
-   rffi.txt
+   .. STUFF THAT'S DIFFICULT TO CATEGORIZE
+   video-index.txt
 
 
 Getting into PyPy ...