[pypy-svn] pypy default: (dmalcolm, lac): Move various comments from inside toctree directives to other locations, as it causes warnings

dmalcolm commits-noreply at bitbucket.org
Thu Mar 17 19:04:52 CET 2011


Author: David Malcolm <dmalcolm at redhat.com>
Branch: 
Changeset: r42765:177cd3582f16
Date: 2011-03-16 16:04 -0400
http://bitbucket.org/pypy/pypy/changeset/177cd3582f16/

Log:	(dmalcolm, lac): Move various comments from inside toctree
	directives to other locations, as it causes warnings

diff --git a/pypy/doc/geninterp.rst b/pypy/doc/geninterp.rst
--- a/pypy/doc/geninterp.rst
+++ b/pypy/doc/geninterp.rst
@@ -1,3 +1,7 @@
+.. include:: crufty.rst
+
+     .. ^^ apparently dead
+
 The Interpreter-Level backend
 -----------------------------
 

diff --git a/pypy/doc/sandbox.rst b/pypy/doc/sandbox.rst
--- a/pypy/doc/sandbox.rst
+++ b/pypy/doc/sandbox.rst
@@ -1,3 +1,7 @@
+.. include:: crufty.rst
+
+     .. ^^ it continues to work, but is unmaintained
+
 PyPy's sandboxing features
 ==========================
 

diff --git a/pypy/doc/index.rst b/pypy/doc/index.rst
--- a/pypy/doc/index.rst
+++ b/pypy/doc/index.rst
@@ -75,10 +75,12 @@
 
 .. The following documentation is important and reasonably up-to-date:
 
+.. extradoc: should this be integrated one level up: dcolish?
+
+
 .. toctree::
    :maxdepth: 1
 
-   .. The following stuff is high-value and (vaguely) true:
    getting-started.rst
    getting-started-python.rst
    getting-started-dev.rst
@@ -96,13 +98,11 @@
    extending.rst
 
    extradoc.rst
-     .. ^^ integrate this one level up: dcolish?
 
    glossary.rst
 
    contributor.rst
 
-   .. True, high-detail:
    interpreter-optimizations.rst
    configuration.rst
    low-level-encapsulation.rst
@@ -118,16 +118,12 @@
    index-of-release-notes.rst
 
    ctypes-implementation.rst
-     .. ^^ needs attention
 
    how-to-release.rst
-     .. ^^ needs attention
 
    index-report.rst
-     .. ^^ of historic interest, and about EU fundraising
 
    stackless.rst
-     .. ^^ it still works; needs JIT integration; hasn't been maintained for years
 
    discussions.rst
 

diff --git a/pypy/doc/how-to-release.rst b/pypy/doc/how-to-release.rst
--- a/pypy/doc/how-to-release.rst
+++ b/pypy/doc/how-to-release.rst
@@ -1,3 +1,5 @@
+.. include:: crufty.rst
+
 Making a PyPy Release
 =======================
 

diff --git a/pypy/doc/externaltools.rst b/pypy/doc/externaltools.rst
--- a/pypy/doc/externaltools.rst
+++ b/pypy/doc/externaltools.rst
@@ -1,3 +1,7 @@
+.. include:: crufty.rst
+
+     .. ^^ Incomplete and wrong,  superceded elsewhere
+
 External tools&programs needed by PyPy
 ======================================
 

diff --git a/pypy/doc/ctypes-implementation.rst b/pypy/doc/ctypes-implementation.rst
--- a/pypy/doc/ctypes-implementation.rst
+++ b/pypy/doc/ctypes-implementation.rst
@@ -1,3 +1,4 @@
+.. include:: crufty.rst
 
 =============================
 PyPy's ctypes implementation 

diff --git a/pypy/doc/distribution.rst b/pypy/doc/distribution.rst
--- a/pypy/doc/distribution.rst
+++ b/pypy/doc/distribution.rst
@@ -1,3 +1,6 @@
+.. include:: crufty.rst
+
+     .. ^^ Incomplete,  superceded elsewhere
 
 ========================
 lib/distributed features

diff --git a/pypy/doc/index-report.rst b/pypy/doc/index-report.rst
--- a/pypy/doc/index-report.rst
+++ b/pypy/doc/index-report.rst
@@ -1,3 +1,5 @@
+.. include:: crufty.rst
+
 ============================================
 PyPy - Overview over the EU-reports
 ============================================

diff --git a/pypy/doc/stackless.rst b/pypy/doc/stackless.rst
--- a/pypy/doc/stackless.rst
+++ b/pypy/doc/stackless.rst
@@ -2,9 +2,15 @@
          Application-level Stackless features
 ==========================================================
 
+
+
 Introduction
 ================
 
+.. include:: crufty.rst
+
+   .. apparently this still works; needs JIT integration; hasn't been maintained for years
+
 PyPy can expose to its user language features similar to the ones
 present in `Stackless Python`_: **no recursion depth limit**, and the
 ability to write code in a **massively concurrent style**.  It actually

diff --git a/pypy/doc/cleanup.rst b/pypy/doc/cleanup.rst
--- a/pypy/doc/cleanup.rst
+++ b/pypy/doc/cleanup.rst
@@ -1,17 +1,21 @@
 Old documentation that needs review
 -----------------------------------
+
+.. The following stuff is old (and crufty?), and needs further investigation:
+
+.. doc-index: This needs merging somehow
+
+.. svn-help.rst: Needs merging/replacing with hg stuff:
+
+
 .. toctree::
 
-   .. The following stuff is old (and crufty?), and needs further investigation:
    buildtool.rst
    distribution.rst
-     .. ^^ Incomplete,  superceded elsewhere
 
    externaltools.rst
-     .. ^^ Incomplete and wrong,  superceded elsewhere
 
    geninterp.rst
-     .. ^^ apparently dead
 
    objspace-proxies.rst
 
@@ -22,29 +26,21 @@
    rffi.rst
 
    sandbox.rst
-     .. ^^ it continues to work, but is unmaintained
 
    statistic/index.rst
 
    theory.rst
-     .. ^^ old ideas; we're not doing it this way any more
 
    translation-aspects.rst
-     .. ^^ old and needs updating
 
-   .. This needs merging somehow:
    docindex.rst
 
-   .. Needs merging/replacing with hg stuff:
    svn-help.rst
 
    dot-net.rst
 
    maemo.rst
-     .. ^^ obscure corner; not sure of status
 
-   .. STUFF THAT'S DIFFICULT TO CATEGORIZE
-   video-index.rst
 
 
 

diff --git a/pypy/doc/translation-aspects.rst b/pypy/doc/translation-aspects.rst
--- a/pypy/doc/translation-aspects.rst
+++ b/pypy/doc/translation-aspects.rst
@@ -1,3 +1,6 @@
+.. include:: crufty.rst
+.. ^^ old and needs updating
+
 ==========================================================================================
 Memory management and threading models as translation aspects -- solutions and challenges
 ==========================================================================================

diff --git a/pypy/doc/theory.rst b/pypy/doc/theory.rst
--- a/pypy/doc/theory.rst
+++ b/pypy/doc/theory.rst
@@ -1,3 +1,7 @@
+.. include:: crufty.rst
+
+     .. ^^ old ideas; we're not doing it this way any more
+
 ===================================
 Techniques used in PyPy
 ===================================


More information about the Pypy-commit mailing list