[Python-checkins] r56517 - doctools/trunk/README

georg.brandl python-checkins at python.org
Tue Jul 24 11:39:58 CEST 2007


Author: georg.brandl
Date: Tue Jul 24 11:39:57 2007
New Revision: 56517

Modified:
   doctools/trunk/README
Log:
Update the readme a bit.


Modified: doctools/trunk/README
==============================================================================
--- doctools/trunk/README	(original)
+++ doctools/trunk/README	Tue Jul 24 11:39:57 2007
@@ -1,9 +1,5 @@
-py-rest-doc
-===========
-
-This sandbox project is about moving the official Python documentation
-to reStructuredText.
-
+doctools README
+===============
 
 What you need to know
 ---------------------
@@ -78,3 +74,13 @@
 where you can configure the server and port for the application as
 well as different other settings specific to the web app.
 
+
+Writing new documentation
+-------------------------
+
+The new "Documenting Python" document, contained in a converted documentation
+tree, already lists most of the markup and features, both standard reST and
+additional, that can be used in the source docs.
+
+More reST docs are at http://docutils.sf.net/rst.html, tutorials can be found on
+the web.
\ No newline at end of file


More information about the Python-checkins mailing list