Commits

Anonymous committed cca1db8

Update TODO and README.

  • Participants
  • Parent commits ce16dc0

Comments (0)

Files changed (6)

Doc-26/README.txt

 
 Documentation on the authoring Python documentation, including information about
 both style and markup, is available in the "Documenting Python" chapter of the
-documentation.
+documentation.  There's also a chapter intended to point out differences to
+those familiar with the previous docs written in LaTeX.
 
 
 Building the docs
-To do after conversion
-======================
+To do
+=====
 
 * split very large files and add toctrees
-* find out which files get "comments disabled" metadata
 * finish "Documenting Python"
+* care about XXX comments

Doc-26/documenting/fromlatex.rst

         The equals operator.
 
 
+Structure
+---------
+
+The LaTeX docs were split in several toplevel manuals.  Now, all files
+are part of the same documentation tree, as indicated by the *toctree*
+directives in the sources.  Every *toctree* directive embeds other files
+as subdocuments of the current file (this structure is not necessarily
+mirrored in the filesystem layout).  The toplevel file is
+:file:`contents.rst`.
+
+However, most of the old directory structure has been kept, with the
+directories renamed as follows:
+
+* :file:`api` -> :file:`c-api`
+* :file:`dist` -> :file:`distutils`, with the single TeX file split up
+* :file:`doc` -> :file:`documenting`
+* :file:`ext` -> :file:`extending`
+* :file:`inst` -> :file:`installing`
+* :file:`lib` -> :file:`library`
+* :file:`mac` -> merged into :file:`library`, with `mac/using.tex`
+  moved to `howto/pythonmac.rst`
+* :file:`ref` -> :file:`reference`
+* :file:`tut` -> :file:`tutorial`, with the single TeX file split up
+
+
 .. XXX more (index-generating, production lists, ...)

Doc-3k/README.txt

 
 Documentation on the authoring Python documentation, including information about
 both style and markup, is available in the "Documenting Python" chapter of the
-documentation.
+documentation.  There's also a chapter intended to point out differences to
+those familiar with the previous docs written in LaTeX.
 
 
 Building the docs
-To do after conversion
-======================
+To do
+=====
 
 * split very large files and add toctrees
-* find out which files get "comments disabled" metadata
 * finish "Documenting Python"
+* care about XXX comments

Doc-3k/documenting/fromlatex.rst

         The equals operator.
 
 
+Structure
+---------
+
+The LaTeX docs were split in several toplevel manuals.  Now, all files
+are part of the same documentation tree, as indicated by the *toctree*
+directives in the sources.  Every *toctree* directive embeds other files
+as subdocuments of the current file (this structure is not necessarily
+mirrored in the filesystem layout).  The toplevel file is
+:file:`contents.rst`.
+
+However, most of the old directory structure has been kept, with the
+directories renamed as follows:
+
+* :file:`api` -> :file:`c-api`
+* :file:`dist` -> :file:`distutils`, with the single TeX file split up
+* :file:`doc` -> :file:`documenting`
+* :file:`ext` -> :file:`extending`
+* :file:`inst` -> :file:`installing`
+* :file:`lib` -> :file:`library`
+* :file:`mac` -> merged into :file:`library`, with `mac/using.tex`
+  moved to `howto/pythonmac.rst`
+* :file:`ref` -> :file:`reference`
+* :file:`tut` -> :file:`tutorial`, with the single TeX file split up
+
+
 .. XXX more (index-generating, production lists, ...)