mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update TODO and README.
This commit is contained in:
parent
e8c3a65147
commit
c52b0f6f23
@ -7,7 +7,8 @@ available at http://docs.python.org/download/.
|
||||
|
||||
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
|
||||
|
@ -1,6 +1,6 @@
|
||||
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
|
||||
|
@ -164,4 +164,29 @@ These changes to information units should be noted:
|
||||
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, ...)
|
||||
|
@ -7,7 +7,8 @@ available at http://docs.python.org/download/.
|
||||
|
||||
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
|
||||
|
@ -1,6 +1,6 @@
|
||||
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
|
||||
|
@ -164,4 +164,29 @@ These changes to information units should be noted:
|
||||
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, ...)
|
||||
|
Loading…
Reference in New Issue
Block a user