Commits

David Malcolm  committed 177cd35

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

  • Participants
  • Parent commits 11a3f52

Comments (0)

Files changed (12)

File pypy/doc/cleanup.rst

 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
 
    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
 
 
 

File pypy/doc/ctypes-implementation.rst

+.. include:: crufty.rst
 
 =============================
 PyPy's ctypes implementation 

File pypy/doc/distribution.rst

+.. include:: crufty.rst
+
+     .. ^^ Incomplete,  superceded elsewhere
 
 ========================
 lib/distributed features

File pypy/doc/externaltools.rst

+.. include:: crufty.rst
+
+     .. ^^ Incomplete and wrong,  superceded elsewhere
+
 External tools&programs needed by PyPy
 ======================================
 

File pypy/doc/geninterp.rst

+.. include:: crufty.rst
+
+     .. ^^ apparently dead
+
 The Interpreter-Level backend
 -----------------------------
 

File pypy/doc/how-to-release.rst

+.. include:: crufty.rst
+
 Making a PyPy Release
 =======================
 

File pypy/doc/index-report.rst

+.. include:: crufty.rst
+
 ============================================
 PyPy - Overview over the EU-reports
 ============================================

File pypy/doc/index.rst

 
 .. 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
    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
    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
 

File pypy/doc/sandbox.rst

+.. include:: crufty.rst
+
+     .. ^^ it continues to work, but is unmaintained
+
 PyPy's sandboxing features
 ==========================
 

File pypy/doc/stackless.rst

          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

File pypy/doc/theory.rst

+.. include:: crufty.rst
+
+     .. ^^ old ideas; we're not doing it this way any more
+
 ===================================
 Techniques used in PyPy
 ===================================

File pypy/doc/translation-aspects.rst

+.. include:: crufty.rst
+.. ^^ old and needs updating
+
 ==========================================================================================
 Memory management and threading models as translation aspects -- solutions and challenges
 ==========================================================================================