SF.net SVN: matplotlib: [5220] trunk/matplotlib/doc/users_guide/source

[<ds...@us...>]

Revision: 5220
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5220&view=rev
Author:   dsdale
Date:     2008-05-22 14:49:25 -0700 (Thu, 22 May 2008)

Log Message:
-----------
added a section to the dev guide explaining how to get up and running 
with Sphinx

Modified Paths:
--------------
    trunk/matplotlib/doc/users_guide/source/developerguide.txt

Added Paths:
-----------
    trunk/matplotlib/doc/users_guide/source/documenting_mpl.txt

Modified: trunk/matplotlib/doc/users_guide/source/developerguide.txt
===================================================================
--- trunk/matplotlib/doc/users_guide/source/developerguide.txt	2008-05-22 21:02:08 UTC (rev 5219)
+++ trunk/matplotlib/doc/users_guide/source/developerguide.txt	2008-05-22 21:49:25 UTC (rev 5220)
@@ -8,4 +8,5 @@
    :maxdepth: 3
 
    coding_guide
+   documenting_mpl
    add_new_projection

Added: trunk/matplotlib/doc/users_guide/source/documenting_mpl.txt
===================================================================
--- trunk/matplotlib/doc/users_guide/source/documenting_mpl.txt	                        (rev 0)
+++ trunk/matplotlib/doc/users_guide/source/documenting_mpl.txt	2008-05-22 21:49:25 UTC (rev 5220)
@@ -0,0 +1,43 @@
+**********************
+Documenting Matplotlib
+**********************
+
+The documentation for matplotlib is generated from ReStructured Text
+using the Sphinx_ documentation generation tool. Sphinx-0.4 or later 
+is required to generate xml files to render mathematical expressions 
+with mathml. Currently this means we need to install from the svn 
+repository by doing::
+
+  svn co http://svn.python.org/projects/doctools/trunk sphinx
+  cd sphinx
+  python setup.py install
+
+.. _Sphinx: http://sphinx.pocoo.org/
+
+The documentation sources are found in the doc/ directory in the trunk.
+To build the users guid in html format, cd into doc/users_guide and do::
+
+  python make.py html
+
+you can also pass a ``latex`` flag to make.py to build a pdf, or pass no 
+arguments to build everything. The same procedure can be followed for
+the sources in doc/api_reference.
+
+The actual ReStructured Text files are kept in doc/users_guide/source
+and doc/api_reference/source. The main entry point is index.txt. 
+Additional files can be added by including their base file name 
+(dropping the .txt extension) in the table of contents. It is also 
+possible to include other documents through the use of an include 
+statement. For example, in the Developers Guide, index.txt lists 
+coding_guide, which automatically inserts coding_guide.txt. 
+coding_guide.txt is just a placeholder, it contains one line only to 
+gets its contents from the CODING_GUIDE file in the trunk: 
+``.. include:: ../../CODING_GUIDE``.
+
+The output produced by Sphinx can be configured by editing the conf.py
+files located in the documentation source directories.
+
+The Sphinx website contains plenty of documentation_ concerning ReST
+markup and working with Sphinx in general.
+
+.. _documentation: http://sphinx.pocoo.org/contents.html
\ No newline at end of file


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