added api file for matplotlib configuration

ddale · ddale · commit 4d3348e6d9bd · 2008-06-13T12:11:33.000Z
svn path=/trunk/matplotlib/; revision=5500
diff --git a/doc/api/matplotlib_configuration_api.rst b/doc/api/matplotlib_configuration_api.rst
@@ -0,0 +1,24 @@
+************************
+matplotlib configuration
+************************
+
+
+:mod:`matplotlib`
+=================
+
+.. autofunction:: matplotlib.get_backend
+.. autofunction:: matplotlib.get_configdir
+.. autofunction:: matplotlib.interactive
+.. autofunction:: matplotlib.rc
+.. autofunction:: matplotlib.rcdefaults
+.. autoclass:: matplotlib.RcParams
+.. autofunction:: matplotlib.use
+.. autoclass:: matplotlib.Verbose
+
+
+:mod:`matplotlib.rcsetup`
+=============================
+
+.. automodule:: matplotlib.rcsetup
+   :members:
+   :undoc-members:
diff --git a/doc/users/customizing.rst b/doc/users/customizing.rst
@@ -20,13 +20,12 @@ locations, in the following order:
    specific customizations that you do not want to apply elsewhere.
 2. :file:`.matplotlib/matplotlibrc`, for the user's default customizations. See
    :ref:`locating-matplotlib-config-dir`.
-3. :file:`{INSTALL}/matplotlib/mpl-data/matplotlibrc`, where
-   :file:`{INSTALL}` is something like
-   :file:`/usr/lib/python2.5/site-packages` on Linux, and maybe
-   :file:`C:\\Python25\\Lib\\site-packages` on Windows. Every time you
-   install matplotlib, this file will be overwritten, so if you want
-   your customizations to be saved, please move this file to you
-   :file:`.matplotlib` directory.
+3. :file:`{INSTALL}/matplotlib/mpl-data/matplotlibrc`, where :file:`{INSTALL}`
+   is something like :file:`/usr/lib/python2.5/site-packages` on Linux, and
+   maybe :file:`C:\\Python25\\Lib\\site-packages` on Windows. Every time you
+   install matplotlib, this file will be overwritten, so if you want your
+   customizations to be saved, please move this file to you :file:`.matplotlib`
+   directory.
 
 
 See below for a sample :ref:`matplotlibrc file<matplotlibrc-sample>`.
