[Python-checkins] r62594 - sandbox/trunk/ttk-gsoc/README

[guilherme.polo]

Author: guilherme.polo
Date: Wed Apr 30 16:24:54 2008
New Revision: 62594

Log:
Added some information on how to read the currently available Ttk documentation

Modified:
   sandbox/trunk/ttk-gsoc/README

Modified: sandbox/trunk/ttk-gsoc/README
==============================================================================
--- sandbox/trunk/ttk-gsoc/README	(original)
+++ sandbox/trunk/ttk-gsoc/README	Wed Apr 30 16:24:54 2008
@@ -16,6 +16,29 @@
     nice features.
 
 
+Reading the Documentation
+=========================
+
+There are just a ttk.rst and two .diffs at Doc/library and while you
+could read the ttk.rst with any editor you will probably want to read
+it nicely formatted as html.
+To generate this html, you will have to checkout the python trunk 
+repository (the one I tested with the docs):
+
+   $ svn co http://svn.python.org/projects/python/trunk python-trunk
+
+And then apply both .diffs using patch -p0 < file.diff. Note that
+these diffs aren't really necessary, so you may skip this. Next you
+have to place ttk-gsoc/Doc/library/ttk.rst in python-trunk/Doc/library
+and then cd into python-trunk/Doc/library and do:
+
+   $ make html
+
+After it completes, you can use your browser to read the Ttk documentation
+(incomplete for now). The path to the ttk.html will be something like 
+file:///SOMEPATH/python-trunk/Doc/build/html/library/ttk.html
+
+
 References
 ==========