[pypy-svn] pypy default: (dmalcolm, lac, necaris): Work-in-progress on organizing the docs

dmalcolm commits-noreply at bitbucket.org
Thu Mar 17 18:55:43 CET 2011


Author: David Malcolm <dmalcolm at redhat.com>
Branch: 
Changeset: r42741:8a599a3234f9
Date: 2011-03-14 13:05 -0400
http://bitbucket.org/pypy/pypy/changeset/8a599a3234f9/

Log:	(dmalcolm, lac, necaris): Work-in-progress on organizing the docs

diff --git a/pypy/doc/glossary.txt b/pypy/doc/glossary.txt
--- a/pypy/doc/glossary.txt
+++ b/pypy/doc/glossary.txt
@@ -1,7 +1,17 @@
+.. _glossary:
+
+********
+Glossary
+********
+
 PyPy, like any large project, has developed a jargon of its own.  This
 document gives brief definition of some of these terms and provides
 links to more information.
 
+.. if you add new entries, keep the alphabetical sorting!
+
+.. glossary::
+
 **abstract interpretation**
     The technique of interpreting the bytecode of a user program with
     an interpreter that handles abstract objects instead of concrete ones.

diff --git a/pypy/doc/index.txt b/pypy/doc/index.txt
--- a/pypy/doc/index.txt
+++ b/pypy/doc/index.txt
@@ -1,3 +1,6 @@
+
+Welcome to PyPy Development
+=============================================
 
 The PyPy project aims at producing a flexible and fast Python_
 implementation.  The guiding idea is to translate a Python-level
@@ -5,6 +8,149 @@
 Rumors have it that the secret goal is being faster-than-C which is
 nonsense, isn't it?  `more...`_
 
+.. toctree::
+   :maxdepth: 2
+
+   .. The following stuff has not yet been categorized:
+
+   sandbox.txt
+   sprint-reports.txt
+   stackless.txt
+   statistic/index.txt
+   svn-help.txt
+   theory.txt
+   translation.txt
+   translation-aspects.txt
+   video-index.txt
+   windows.txt
+   discussion/GC-performance.txt
+   discussion/VM-integration.txt
+   discussion/chained_getattr.txt
+   discussion/cli-optimizations.txt
+   discussion/cmd-prompt-translation.txt
+   discussion/compiled-swamp.txt
+   discussion/ctypes_modules.txt
+   discussion/ctypes_todo.txt
+   discussion/distribution.txt
+   discussion/distribution-implementation.txt
+   discussion/distribution-newattempt.txt
+   discussion/distribution-roadmap.txt
+   discussion/emptying-the-malloc-zoo.txt
+   discussion/finalizer-order.txt
+   discussion/gc.txt
+   discussion/howtoimplementpickling.txt
+   discussion/improve-rpython.txt
+   discussion/outline-external-ootype.txt
+   discussion/oz-thread-api.txt
+   discussion/paper-wishlist.txt
+   discussion/parsing-ideas.txt
+   discussion/pypy_metaclasses_in_cl.txt
+   discussion/removing-stable-compiler.txt
+   discussion/security-ideas.txt
+   discussion/somepbc-refactoring-plan.txt
+   discussion/summer-of-pypy-pytest.txt
+   discussion/testing-zope.txt
+   discussion/thoughts_string_interning.txt
+   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
+
+
 Getting into PyPy ... 
 =============================================
 
@@ -57,3 +203,12 @@
 .. _`Getting Started`: getting-started.html
 .. _papers: extradoc.html
 .. _`Release 1.4`: http://pypy.org/download.html
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+* :ref:`glossary`
+


More information about the Pypy-commit mailing list