Menu
▾
▴
SF.net SVN: matplotlib: [5486] trunk/matplotlib/doc
|
From: <jd...@us...> - 2008-06-12 16:39:05
|
Revision: 5486
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5486&view=rev
Author: jdh2358
Date: 2008-06-12 09:38:47 -0700 (Thu, 12 Jun 2008)
Log Message:
-----------
some minor doc fixes and reorg, closed usetex review (thanks darren!)
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
trunk/matplotlib/doc/faq/environment_variables_faq.rst
trunk/matplotlib/doc/faq/howto_faq.rst
trunk/matplotlib/doc/faq/installing_faq.rst
trunk/matplotlib/doc/faq/troubleshooting_faq.rst
trunk/matplotlib/doc/users/customizing.rst
trunk/matplotlib/doc/users/event_handling.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -27,8 +27,8 @@
legends ? no author ?
animation John has author ?
collections ? no author ?
-text - mathtext Michael in review John
-text - usetex Darren in review John
+text - mathtext Michael accepted John
+text - usetex Darren accepted John
text - annotations John submitted ?
fonts et al Michael ? no author Darren
pyplot tut John submitted Eric
@@ -173,7 +173,7 @@
Validation is actually built into RcParams. This was done
just prior to development of the traited config, validation is done using
the mechanisms developed in rcsetup. For example::
-
+
>>> rcParams['a.b']=1
---------------------------------------------------------------------------
KeyError Traceback (most recent call last)
@@ -214,7 +214,7 @@
ValueError: Could not convert "" to boolean
-
+
#. DONE - You give the example::
import matplotlib.cbook as cbook
@@ -286,6 +286,8 @@
similarly to the :file: directive in html. Let me know if you don't want to
use the file directive.
+ - JDH: let's go with the file directive.
+
#. DONE - try and use internal reference links for every section and be
generous with the sections. Eg, I added a section headers and
internal linka for the postscript and unicode sections (we will
Modified: trunk/matplotlib/doc/faq/environment_variables_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/environment_variables_faq.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/faq/environment_variables_faq.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -22,10 +22,10 @@
This is the directory used to store user customizations to matplotlib, as
well as some caches to improve performance. If :envvar:`MPLCONFIGDIR` is not
defined, :file:`{HOME}/.matplotlib` is used by default.
-
+
.. _setting-linux-osx-environment-variables:
-Setting Environment Variables in Linux and OS-X
+Setting environment variables in Linux and OS-X
===============================================
To list the current value of :envvar:`PYTHONPATH`, which may be empty, try::
@@ -37,8 +37,8 @@
should be able to determine which by running at the command prompt::
echo $SHELL
-
+
BASH/KSH
--------
@@ -50,13 +50,14 @@
export PATH=~/bin:${PATH}
-The search order may be important to you, do you want `~/bin` to be searched
-first or last? To append to an existing environment variable::
+The search order may be important to you, do you want :file:`~/bin` to
+be searched first or last? To append to an existing environment
+variable::
export PATH=${PATH}:~/bin
To make your changes available in the future, add the commands to your
-`~/.bashrc` file.
+:file:`~/.bashrc` file.
CSH/TCSH
@@ -70,19 +71,19 @@
setenv PATH ~/bin:${PATH}
-The search order may be important to you, do you want `~/bin` to be searched
+The search order may be important to you, do you want :file:`~/bin` to be searched
first or last? To append to an existing environment variable::
setenv PATH ${PATH}:~/bin
To make your changes available in the future, add the commands to your
-`~/.cshrc` file.
+:file:`~/.cshrc` file.
.. _setting-windows-environment-variables:
-Setting Environment Variables in Windows
+Setting environment variables in windows
========================================
Go to the Windows start menu, select `Control Panel`, then select the `System`
icon, click the `Advanced` tab, and select the `Environment Variables`
-button. You can edit or add to the `user variables`.
\ No newline at end of file
+button. You can edit or add to the `user variables`.
Modified: trunk/matplotlib/doc/faq/howto_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/howto_faq.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/faq/howto_faq.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -1,28 +1,10 @@
-.._ howto-faq:
+.. _howto-faq:
*****
HOWTO
*****
-.. _locating-matplotlib-config-dir:
-Where is my .matplotlib directory?
-==================================
-
-Each user has a :file:`.matplotlib/` directory which may contain a
-:ref:`matplotlibrc <customizing-with-matplotlibrc-files>` file and various
-caches to improve matplotlib's performance. To locate your :file:`.matplotlib/`
-directory, use :func:`matplotlib.get_configdir`:
-
- >>> import matplotlib as mpl
- >>> mpl.get_configdir()
- '/home/darren/.matplotlib'
-
-This directory is generally located in your :envvar:`HOME` directory, but if
-you would like to use a configuration directory other than
-:file:`{HOME}/.matplotlib/`, you can do so by specifying the location in your
-:envvar:`MPLCONFIGDIR` environment variable.
-
.. _howto-ticks:
How do I configure the tick linewidths?
Modified: trunk/matplotlib/doc/faq/installing_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/installing_faq.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/faq/installing_faq.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -4,6 +4,8 @@
Installation FAQ
******************
+
+
How do I report a compilation problem?
======================================
@@ -131,7 +133,7 @@
============ ===================================================================================================
-OS X Questions
+OS-X questions
==============
.. _easy-install-osx-egg:
Modified: trunk/matplotlib/doc/faq/troubleshooting_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/faq/troubleshooting_faq.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -4,7 +4,59 @@
Troubleshooting FAQ
===================
+.. _matplotlib-version:
+What is my matplotlib version?
+==============================
+
+To find out your matplotlib version number, import it and print the
+``__version__`` attribute::
+
+ >>> import matplotlib
+ >>> matplotlib.__version__
+ '0.98.0'
+
+
+.. _locating-matplotlib-install:
+
+Where is matplotlib installed?
+==============================
+
+You can find what directory matplotlib is installed in by importing it
+and printing the ``__file__`` attribute::
+
+ >>> import matplotlib
+ >>> matplotlib.__file__
+ '/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/__init__.pyc'
+
+.. _locating-matplotlib-config-dir:
+
+Where is my .matplotlib directory?
+==================================
+
+Each user has a :file:`.matplotlib/` directory which may contain a
+:ref:`matplotlibrc <customizing-with-matplotlibrc-files>` file and various
+caches to improve matplotlib's performance. To locate your :file:`.matplotlib/`
+directory, use :func:`matplotlib.get_configdir`:
+
+ >>> import matplotlib as mpl
+ >>> mpl.get_configdir()
+ '/home/darren/.matplotlib'
+
+On unix like systems, this directory is generally located in your
+:envvar:`HOME` directory. On windows, it is in your documents and
+settings directory by default::
+
+ >>> import matplotlib
+ >>> mpl.get_configdir()
+ 'C:\\Documents and Settings\\jdhunter\\.matplotlib'
+
+If you would like to use a different configuration directory, you can
+do so by specifying the location in your :envvar:`MPLCONFIGDIR`
+environment variable -- see
+:ref:`setting-linux-osx-environment-variables`.
+
+
.. _reporting-problems:
How do I report a problem?
@@ -40,7 +92,7 @@
> python simple_plot.py --verbose-helpful > output.txt
-If you compiled matplotlib yourself, please also provide
+If you compiled matplotlib yourself, please also provide
* any changes you have made to ``setup.py`` or ``setupext.py``
* the output of::
@@ -50,7 +102,7 @@
The beginning of the build output contains lots of details about your
platform that are useful for the matplotlib developers to diagnose
- your problem.
+ your problem.
* your compiler version -- eg, ``gcc --version``
Modified: trunk/matplotlib/doc/users/customizing.rst
===================================================================
--- trunk/matplotlib/doc/users/customizing.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/users/customizing.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -20,18 +20,20 @@
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
- :file:`{HOME}/.matplotlib/matplotlibrc`.
+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>`.
.. _customizing-with-dynamic-rc-settings:
-Dynamic rc Settings
+Dynamic rc settings
===================
You can also dynamically change the default rc settings in a python script or
Modified: trunk/matplotlib/doc/users/event_handling.rst
===================================================================
--- trunk/matplotlib/doc/users/event_handling.rst 2008-06-12 16:19:14 UTC (rev 5485)
+++ trunk/matplotlib/doc/users/event_handling.rst 2008-06-12 16:38:47 UTC (rev 5486)
@@ -141,7 +141,7 @@
``key``
the key pressed: None, chr(range(255), 'shift', 'win', or 'control'
-Draggable Rectangle Exercise
+Draggable rectangle exercise
----------------------------
Write draggable rectangle class that is initialized with a
@@ -332,7 +332,7 @@
.. _object-picking:
-Object Picking
+Object picking
==============
You can enable picking by setting the ``picker`` property of an
@@ -436,7 +436,7 @@
plt.show()
-Picking Exercise
+Picking exercise
----------------
Create a data set of 100 arrays of 1000 Gaussian random numbers and
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|