experimenting with including api docs

jdh2358 · jdh2358 · commit 5408064f124e · 2008-05-23T18:59:09.000Z
svn path=/trunk/matplotlib/; revision=5236
diff --git a/doc/users_guide/artist_api_tut.txt b/doc/users_guide/artist_api_tut.txt
@@ -1,4 +1,4 @@
-**************
+***************
 Artist tutorial
 ***************
 
diff --git a/doc/users_guide/index.txt b/doc/users_guide/index.txt
@@ -12,3 +12,4 @@ Matplotlib
 
    users_guide
    developers_guide
+   api
diff --git a/doc/users_guide/introduction.txt b/doc/users_guide/introduction.txt
@@ -4,8 +4,8 @@ Introduction
 
 matplotlib is a library for making 2D plots of arrays in `Python
 <http://www.python.org>`_.  Although it has its origins in emulating
-the `MATLAB™ <http://www.mathworks.com>`_ graphics commands, it does
-not require MATLAB™, and can be used in a Pythonic, object oriented
+the `Matlab (TM) <http://www.mathworks.com>`_ graphics commands, it does
+not require MATLAB (TM), and can be used in a Pythonic, object oriented
 way.  Although matplotlib is written primarily in pure Python, it
 makes heavy use of `NumPy <http://www.numpy.org>`_ and other extension
 code to provide good performance even for large arrays.
@@ -16,13 +16,13 @@ want to see a histogram of your data, you shouldn't need to
 instantiate objects, call methods, set properties, and so on; it
 should just work.
 
-For years, I used to use MATLAB™ exclusively for data analysis and
-visualization.  MATLAB™ excels at making nice looking plots easy.  When
+For years, I used to use MATLAB exclusively for data analysis and
+visualization.  Matlab excels at making nice looking plots easy.  When
 I began working with EEG data, I found that I needed to write
 applications to interact with my data, and developed and EEG analysis
-application in MATLAB™.  As the application grew in complexity,
+application in Matlab.  As the application grew in complexity,
 interacting with databases, http servers, manipulating complex data
-structures, I began to strain against the limitations of MATLAB™ as a
+structures, I began to strain against the limitations of Matlab as a
 programming language, and decided to start over in Python.  Python
 more than makes up for all of matlab's deficiencies as a programming
 language, but I was having difficulty finding a 2D plotting package
@@ -47,9 +47,9 @@ requirements:
 Finding no package that suited me just right, I did what any
 self-respecting Python programmer would do: rolled up my sleeves and
 dived in.  Not having any real experience with computer graphics, I
-decided to emulate MATLAB™'s plotting capabilities because that is
-something MATLAB™ does very well.  This had the added advantage that
-many people have a lot of MATLAB™ experience, and thus they can
+decided to emulate Matlab's plotting capabilities because that is
+something Matlab does very well.  This had the added advantage that
+many people have a lot of Matlab experience, and thus they can
 quickly get up to steam plotting in python.  From a developer's
 perspective, having a fixed user interface (the pylab interface) has
 been very useful, because the guts of the code base can be redesigned
@@ -58,7 +58,7 @@ without affecting user code.
 The matplotlib code is conceptually divided into three parts: the
 *pylab interface* is the set of functions provided by
 :mod:`matplotlib.pylab` which allow the user to create plots with code
-quite similar to MATLAB™ figure generating code.  The *matplotlib
+quite similar to Matlab figure generating code.  The *matplotlib
 frontend* or *matplotlib API* is the set of classes that do the heavy
 lifting, creating and managing figures, text, lines, plots and so on.
 This is an abstract interface that knows nothing about output.  The
@@ -77,17 +77,12 @@ and embed it a Gtk+ application, and so on for `PDF
 <http://docs.python.org/lib/module-Tkinter.html>`_ etc.
 
 matplotlib is used by many people in many different contexts.  Some
-people want to automatically generate PostScript® files to send to a
-printer or publishers.  Others deploy matplotlib on a web application
-server to generate PNG output for inclusion in dynamically-generated
-web pages.  Some use matplotlib interactively from the Python shell in
-Tkinter on Windows®.  My primary use is to embed matplotlib in a Gtk+
-EEG application that runs on Windows, Linux and Macintosh OS X.
+people want to automatically generate PostScript® files to send
+to a printer or publishers.  Others deploy matplotlib on a web
+application server to generate PNG output for inclusion in
+dynamically-generated web pages.  Some use matplotlib interactively
+from the Python shell in Tkinter on Windows (TM) My primary use is to
+embed matplotlib in a Gtk+ EEG application that runs on Windows, Linux
+and Macintosh OS X.
 
-Because there are so many ways people want to use a plotting library,
-there is a certain amount of complexity inherent in configuring the
-library so that it will work naturally the way you want it to.  Before
-diving into these details, let's first explore matplotlib's simplicity
-by comparing a typical matplotlib script with its analog in MATLAB™.
 
---- JDH
diff --git a/doc/users_guide/users_guide.txt b/doc/users_guide/users_guide.txt
@@ -13,3 +13,4 @@ User's Guide
    customizing
    artist_api_tut
    event_handling_tut
+   

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-**************`
	`1`	`+***************`
`2`	`2`	`Artist tutorial`
`3`	`3`	`***************`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -12,3 +12,4 @@ Matplotlib`
`12`	`12`
`13`	`13`	`users_guide`
`14`	`14`	`developers_guide`
	`15`	`+ api`