SF.net SVN: matplotlib: [5270] trunk/matplotlib/doc

[<jd...@us...>]

Revision: 5270
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5270&view=rev
Author:   jdh2358
Date:     2008-05-25 14:31:43 -0700 (Sun, 25 May 2008)

Log Message:
-----------
added readme to describe doc organization

Modified Paths:
--------------
    trunk/matplotlib/doc/conf.py

Added Paths:
-----------
    trunk/matplotlib/doc/README.txt

Added: trunk/matplotlib/doc/README.txt
===================================================================
--- trunk/matplotlib/doc/README.txt	                        (rev 0)
+++ trunk/matplotlib/doc/README.txt	2008-05-25 21:31:43 UTC (rev 5270)
@@ -0,0 +1,35 @@
+maptlotlib documentation
+========================
+
+This is the top level build directory for the matplotlib
+documentation.  All of the documentation is written using sphinx, a
+python documentation system built on top of ReST.
+
+If you are looking for plain text documentation, you can read the following
+
+* users - the user documentation, eg plotting tutorials, configuration
+  tips, etc.
+
+* devel - documentation for matplotlib developers
+
+* faq - frequently asked questions
+
+* api - placeholders to automatically generate the api documentation
+
+* make.py - the build script to build the html or PDF docs
+
+* index.rst - the top level include document for matplotlib docs
+
+* conf.py - the sphinx configuration
+
+* _static - used by the sphinx build system
+
+* _templates - used by the sphinx build system
+
+* sphinxext - Sphinx extensions for the mpl docs
+
+* mpl_data - a symbolic link to the matplotlib data for reference by
+  sphinx documentation
+
+* mpl_examples - a link to the matplotlib examples in case any
+  documentation wants to literal include them

Modified: trunk/matplotlib/doc/conf.py
===================================================================
--- trunk/matplotlib/doc/conf.py	2008-05-25 21:24:24 UTC (rev 5269)
+++ trunk/matplotlib/doc/conf.py	2008-05-25 21:31:43 UTC (rev 5270)
@@ -141,7 +141,7 @@
 # (source start file, target name, title, author, document class [howto/manual]).
 
 latex_documents = [
-  ('index', 'Matplotlib.tex', 'Matplotlib', 'John Hunter, Darren Dale, Michael Droettboom', 'manual'),
+  ('index', 'Matplotlib.tex', 'Matplotlib', 'Darren Dale, Michael Droettboom, Eric Firing, John Hunter', 'manual'),
 ]
 
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.