updates to rc and scaling for docs to get nice sizes for html and pdf

jdh2358 · jdh2358 · commit f8e1599b8741 · 2008-06-13T19:23:21.000Z
svn path=/trunk/matplotlib/; revision=5518
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -115,12 +115,13 @@ the images from the python script and including either a png copy for
 html or a pdf for latex::
 
    .. plot:: pyplot_simple.py
-      :scale: 75
       :include-source:
 
-The ``:scale:`` directive rescales the image to some percentage of the original
-size. ``:include-source:`` will present the contents of the file, marked up as
-source code.
+The ``:scale:`` directive rescales the image to some percentage of the
+original size, though we don't recommend using this in most cases
+since it is probably better to choose the correct figure size and dpi
+in mpl and let it handle the scaling. ``:include-source:`` will
+present the contents of the file, marked up as source code.
 
 Static figures
 --------------
diff --git a/doc/matplotlibrc b/doc/matplotlibrc
@@ -233,7 +233,7 @@ numerix      : numpy  # numpy, Numeric or numarray
 
 ### FIGURE
 # See http://matplotlib.sourceforge.net/matplotlib.figure.html#Figure
-#figure.figsize   : 8, 6    # figure size in inches
+figure.figsize   : 6, 4    # figure size in inches
 #figure.dpi       : 80      # figure dots per inch
 #figure.facecolor : 0.75    # figure facecolor; 0.75 is scalar gray
 #figure.edgecolor : white   # figure edgecolor
diff --git a/doc/sphinxext/plot_directive.py b/doc/sphinxext/plot_directive.py
@@ -43,12 +43,13 @@
 template_no_source = """
 .. htmlonly::
 
+   [ `<../%(srcdir)s/%(reference)s>`__,
+    `png <../%(srcdir)s/%(basename)s.hires.png>`__,
+    `pdf <../%(srcdir)s/%(basename)s.pdf>`__ ]
+
    .. image:: ../%(srcdir)s/%(basename)s.png
 %(options)s
 
-   `[%(basename)s source py] <../%(srcdir)s/%(reference)s>`_
-   `[%(basename)s highres png] <../%(srcdir)s/%(basename)s.hires.png>`_
-   `[%(basename)s pdf] <../%(srcdir)s/%(basename)s.pdf>`_
 
 .. latexonly::
    .. image:: ../%(srcdir)s/%(basename)s.pdf
@@ -61,13 +62,13 @@
 
 .. htmlonly::
 
+   [ `py <../%(srcdir)s/%(reference)s>`__,
+   `png <../%(srcdir)s/%(basename)s.hires.png>`__,
+   `pdf <../%(srcdir)s/%(basename)s.pdf>`__ ]
+
    .. image:: ../%(srcdir)s/%(basename)s.png
 %(options)s
 
-   `[%(basename)s source py] <../%(srcdir)s/%(reference)s>`_
-   `[%(basename)s highres png] <../%(srcdir)s/%(basename)s.hires.png>`_
-   `[%(basename)s pdf] <../%(srcdir)s/%(basename)s.pdf>`_
-
 .. latexonly::
    .. image:: ../%(srcdir)s/%(basename)s.pdf
 %(options)s
@@ -103,15 +104,11 @@ def makefig(fullpath, outdir):
 
     mplshell.magic_run(fullpath)
     for format, dpi in formats:
-        #print 'saving', outdir, basename, format
         outname = os.path.join(outdir, '%s.%s' % (basename, format))
         plt.savefig(outname, dpi=dpi)
     print '    all figures made'
 
 def run(arguments, options, state_machine, lineno):
-    #print 'arguments', arguments
-    #print 'options', options
-
     reference = directives.uri(arguments[0])
     basename, ext = os.path.splitext(reference)
 
diff --git a/doc/users/annotations.rst b/doc/users/annotations.rst
@@ -14,7 +14,7 @@ arguments are ``(x,y)`` tuples.
 
 .. plot:: annotation_basic.py
    :include-source:
-   :scale: 75
+
 
 In this example, both the ``xy`` (arrow tip) and ``xytext`` locations
 (text location) are in data coordinates.  There are a variety of other
@@ -73,7 +73,6 @@ keyword args like ``horizontalalignment``, ``verticalalignment`` and
 ``Text`` instance
 
 .. plot:: annotation_polar.py
-   :scale: 75
    :include-source:
 
 See the `annotations demo
diff --git a/doc/users/artists.rst b/doc/users/artists.rst
@@ -136,7 +136,6 @@ drawing of the ticks, tick labels and axis labels.
 Try creating the figure below.
 
 .. plot:: fig_axes_labels_simple.py
-   :scale: 75
 
 .. _customizing-artists:
 
@@ -327,7 +326,6 @@ obtain by setting the ``Artist`` transform to :attr:`fig.transFigure
     In [195]: fig.canvas.draw()
 
 .. plot:: fig_x.py
-   :scale: 75
 
 
 Here is a summary of the Artists the figure contains
@@ -605,7 +603,6 @@ Here is an example, not recommended for its beauty, which customizes
 the axes and tick properties
 
 .. plot:: fig_axes_customize_simple.py
-   :scale: 75
    :include-source:
 
 
@@ -643,5 +640,4 @@ Here is an example which sets the formatter for the upper ticks with
 dollar signs and colors them green on the right side of the yaxis
 
 .. plot:: dollar_ticks.py
-   :scale: 75
    :include-source:
diff --git a/doc/users/mathtext.rst b/doc/users/mathtext.rst
@@ -272,7 +272,6 @@ Example
 Here is an example illustrating many of these features in context.
 
 .. plot:: pyplot_mathtext.py
-   :scale: 75
    :include-source:
 
 
diff --git a/doc/users/navigation_toolbar.rst b/doc/users/navigation_toolbar.rst
@@ -4,20 +4,16 @@ Interactive navigation
 ======================
 
 .. image:: ../_static/toolbar.png
-   :scale: 100
 
 All figure windows come with a navigation toolbar, which can be used
 to navigate through the data set.  Here is a description of each of
 the buttons at the bottom of the toolbar
 
 .. image:: ../mpl_data/images/home.png
-   :scale: 100
 
 .. image:: ../mpl_data/images/back.png
-   :scale: 100
 
 .. image:: ../mpl_data/images/forward.png
-   :scale: 100
 
 The ``Forward`` and ``Back`` buttons
     These are akin to the web browser forward and back buttons.  They
@@ -31,7 +27,6 @@ The ``Forward`` and ``Back`` buttons
     the pan and zoom to rectangle to define new views.
 
 .. image:: ../mpl_data/images/move.png
-   :scale: 100
 
 The ``Pan/Zoom`` button
     This button has two modes: pan and zoom.  Click the toolbar button
@@ -56,7 +51,6 @@ The ``Pan/Zoom`` button
     right mouse button.
 
 .. image:: ../mpl_data/images/zoom_to_rect.png
-   :scale: 100
 
 The ``Zoom-to-rectangle`` button
     Click this toolbar button to activate this mode.  Put your mouse
@@ -68,15 +62,13 @@ The ``Zoom-to-rectangle`` button
     region defined by the zoom out rectangle.
 
 .. image:: ../mpl_data/images/subplots.png
-   :scale: 100
 
 The ``Subplot-configuration`` button
     Use this tool to configure the parameters of the subplot: the
     left, right, top, bottom, space between the rows and space between
     the columns.
 
 .. image:: ../mpl_data/images/filesave.png
-   :scale: 100
 
 The ``Save`` button
     Click this button to launch a file save dialog.  You can save
diff --git a/doc/users/pyplot_tutorial.rst b/doc/users/pyplot_tutorial.rst
@@ -13,7 +13,6 @@ keeps track of the current figure and plotting area, and the plotting
 functions are directed to the current axes
 
 .. plot:: pyplot_simple.py
-   :scale: 75
    :include-source:
 
 You may be wondering why the x-axis ranges from 0-3 and the y-axis
@@ -38,7 +37,6 @@ The default format string is 'b-', which is a solid blue line.  For
 example, to plot the above with red circles, you would issue
 
 .. plot:: pyplot_formatstr.py
-   :scale: 75
    :include-source:
 
 See the :func:`~matplotlib.pyplot.plot` documentation for a complete
@@ -55,7 +53,6 @@ plotting several lines with different format styles in one command
 using arrays.
 
 .. plot:: pyplot_three.py
-   :scale: 75
    :include-source:
 
 .. _controlling-line-properties:
@@ -161,7 +158,6 @@ to worry about this, because it is all taken care of behind the
 scenes.  Below is an script to create two subplots.
 
 .. plot:: pyplot_two_subplots.py
-   :scale: 75
    :include-source:
 
 The :func:`~matplotlib.pyplot.figure` command here is optional because
@@ -221,9 +217,9 @@ are used tox add text in the indicated locations (see :ref:`text-intro`
 for a more detailed example)
 
 .. plot:: pyplot_text.py
-   :scale: 75
    :include-source:
 
+
 All of the :func:`~matplotlib.pyplot.text` commands return an
 :class:`matplotlib.text.Text` instance.  Just as with with lines
 above, you can customize the properties by passing keyword arguments
@@ -265,9 +261,8 @@ functionality to make annotations easy.  In an annotation, there are
 two points to consider: the location being annotated represented by
 the argument ``xy`` and the location of the text ``xytext``.  Both of
 these arguments are ``(x,y)`` tuples.
-  
+
 .. plot:: pyplot_annotate.py
-   :scale: 75
    :include-source:
 
 In this basic example, both the ``xy`` (arrow tip) and ``xytext``
diff --git a/doc/users/text_intro.rst b/doc/users/text_intro.rst
@@ -56,5 +56,4 @@ variety of font and other properties.  The example below shows all of
 these commands in action.
 
 .. plot:: text_commands.py
-   :scale: 75
    :include-source:
diff --git a/doc/users/text_props.rst b/doc/users/text_props.rst
@@ -58,5 +58,4 @@ bounding box, with 0,0 being the lower left of the axes and 1,1 the
 upper right.
 
 .. plot:: text_layout.py
-   :scale: 75
    :include-source:
