FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Plot directive by mdboom · Pull Request #66 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Plot directive #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mdboom wants to merge 11 commits into from
Conversation 6 Commits 11 Checks 0 Files changed
Closed

Plot directive #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a205f54
First pass at reconciling Numpy's version of plot_directive with ours.
mdboom Mar 28, 2011
94b32c4
Update some relative paths to follow the new self-consistent approach…
mdboom Mar 29, 2011
df50940
Add support for custom rcParams -- required to build Numpy docs.
mdboom Mar 31, 2011
917b3d2
Bugfix to support Numpy's "doctest" style input to the plot_directive.
mdboom Mar 31, 2011
19b0be3
The default DPI for PDF is now 200 (it was 50, which is an odd choice)
mdboom Mar 31, 2011
3fb0f99
Add a version to the plot_directive so other tools (such as Numpy) ca…
mdboom Apr 1, 2011
8521225
Add a changelog entry for the plot_directive changes
mdboom Apr 1, 2011
6bae189
Improve plot_directive's docstring and use it from the main docs.
mdboom Apr 1, 2011
f13c3df
Improve plot_directive's docstring and use it from the main docs.
mdboom Apr 1, 2011
403c5b8
Merge branch 'plot_directive' of github.com:mdboom/matplotlib into pl…
mdboom Apr 4, 2011
eecadbb
Remove incorrect item from CHANGELOG
mdboom Apr 4, 2011
File filter

Filter by extension

Filter by extension .py  (1) .rst  (2) No extension  (1) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
5 changes: 5 additions & 0 deletions CHANGELOG
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
2011-04-01 The plot directive Sphinx extension now supports all of the
features in the Numpy fork of that extension. These
include doctest formatting, an 'include-source' option, and
a number of new configuration options. - MGD

2011-03-10 Update pytz version to 2011c, thanks to Simon Cross. - JKS

2011-03-06 Add standalone tests.py test runner script. - JKS
Expand Down
21 changes: 6 additions & 15 deletions doc/devel/documenting_mpl.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -213,19 +213,6 @@ Figures can be automatically generated from scripts and included in
the docs. It is not necessary to explicitly save the figure in the
script, this will be done automatically at build time to ensure that
the code that is included runs and produces the advertised figure.
Several figures will be saved with the same basename as the filename
when the documentation is generated (low and high res PNGs, a PDF).
Matplotlib includes a Sphinx extension
(:file:`sphinxext/plot_directive.py`) for generating the images from
the python script and including either a png copy for html or a pdf
for latex::

.. plot:: pyplots/pyplot_simple.py
:include-source:

If the script produces multiple figures (through multiple calls to
:func:`pyplot.figure`), each will be given a numbered file name and
included.

The path should be relative to the ``doc`` directory. Any plots
specific to the documentation should be added to the ``doc/pyplots``
Expand All @@ -238,8 +225,12 @@ directory. e.g.::
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.
in mpl and let it handle the scaling.

Plot directive documentation
''''''''''''''''''''''''''''

.. automodule:: matplotlib.sphinxext.plot_directive

Static figures
--------------
Expand Down
20 changes: 10 additions & 10 deletions doc/users/image_tutorial.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ plot from the prompt.
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
imgplot = plt.imshow(img)

You can also plot any numpy array - just remember that the datatype
Expand Down Expand Up @@ -188,7 +188,7 @@ This is array slicing. You can read more in the `Numpy tutorial <http://www.sci
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
plt.imshow(lum_img)

Expand All @@ -207,7 +207,7 @@ object:
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
imgplot = plt.imshow(lum_img)
imgplot.set_cmap('hot')
Expand All @@ -221,7 +221,7 @@ object:
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
imgplot = plt.imshow(lum_img)
imgplot.set_cmap('spectral')
Expand All @@ -245,7 +245,7 @@ do that by adding color bars. It's as easy as one line:
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
imgplot = plt.imshow(lum_img)
imgplot.set_cmap('spectral')
Expand Down Expand Up @@ -276,7 +276,7 @@ image data, we use the :func:`~matplotlib.pyplot.hist` function.
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
import numpy as np
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
plt.hist(lum_img.flatten(), 256, range=(0.0,1.0), fc='black', ec='black')

Expand All @@ -300,7 +300,7 @@ object.
import numpy as np
fig = plt.figure()
a=fig.add_subplot(1,2,1)
img = mpimg.imread('_static/stinkbug.png')
img = mpimg.imread('../_static/stinkbug.png')
lum_img = img[:,:,0]
imgplot = plt.imshow(lum_img)
a.set_title('Before')
Expand Down Expand Up @@ -343,7 +343,7 @@ and the computer has to draw in pixels to fill that space.
import matplotlib.image as mpimg
import numpy as np
import Image
img = Image.open('_static/stinkbug.png') # opens the file using PIL - it's not an array yet
img = Image.open('../_static/stinkbug.png') # opens the file using PIL - it's not an array yet
rsize = img.resize((img.size[0]/10,img.size[1]/10)) # resize the image
rsizeArr = np.asarray(rsize)
lum_img = rsizeArr[:,:,0]
Expand All @@ -364,7 +364,7 @@ Let's try some others:
import matplotlib.image as mpimg
import numpy as np
import Image
img = Image.open('_static/stinkbug.png') # opens the file using PIL - it's not an array yet
img = Image.open('../_static/stinkbug.png') # opens the file using PIL - it's not an array yet
rsize = img.resize((img.size[0]/10,img.size[1]/10)) # resize the image
rsizeArr = np.asarray(rsize)
lum_img = rsizeArr[:,:,0]
Expand All @@ -381,7 +381,7 @@ Let's try some others:
import matplotlib.image as mpimg
import numpy as np
import Image
img = Image.open('_static/stinkbug.png') # opens the file using PIL - it's not an array yet
img = Image.open('../_static/stinkbug.png') # opens the file using PIL - it's not an array yet
rsize = img.resize((img.size[0]/10,img.size[1]/10)) # resize the image
rsizeArr = np.asarray(rsize)
lum_img = rsizeArr[:,:,0]
Expand Down
Loading
Back | FazBrowse Home | New Git URL