Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b918016
DOC starting the migration to sphinx
NelleV Mar 8, 2017
b110b1f
DOC Set up sphinx-gallery in parallel of our own gallery
NelleV Mar 9, 2017
ba6d268
DOC added sphinx-gallery as a requirement
NelleV Mar 11, 2017
c908f98
DOC Added readme files to include examples in SG
NelleV Mar 11, 2017
c61c856
DOC SG doesn't support parallel builds yet
NelleV Mar 11, 2017
eaaf182
DOC lines, bars and markers is now full SG
NelleV Mar 11, 2017
4f92501
DOC examples/statistics is fully SG
NelleV Mar 11, 2017
40eab47
DOC pie and polar charts is now full SG
NelleV Mar 11, 2017
9738124
DOC subplots, axes and figures are now full SG
NelleV Mar 11, 2017
8f8d316
DOC added ticks and spines to sphinx-gallery
NelleV Mar 12, 2017
55a5840
DOC image, contours and fields are fully SG compatible
NelleV Mar 16, 2017
9bf91a8
DOC showcase are fully SG compatible
NelleV Mar 16, 2017
f50ab00
DOC text, labels and annotations are fully SG compatible
NelleV Mar 16, 2017
7c79b12
DOC tick and spines is now full SG compatible
NelleV Mar 16, 2017
1ed25aa
DOC shapes and collections is now fully SG compatible
NelleV Mar 17, 2017
8bc4597
DOC mplot3d is fully SG-compatible
NelleV Mar 19, 2017
d5583f8
DOC The gallery is now built with sphinx-gallery
NelleV Mar 19, 2017
8f5f185
DOC all plots in the gallery now produce images
NelleV Mar 19, 2017
9d805a1
DOC API is now fully SG-compatible
NelleV Mar 19, 2017
4a13444
DOC linking to auto_examples when possible
NelleV Mar 19, 2017
8b764e7
DOC FIX nitpicks in the conf file
NelleV Mar 25, 2017
c9b2ad9
Merge branch 'sphinx_gallery' of https://github.com/NelleV/matplotlib…
choldgraf Apr 10, 2017
752cd64
switching to examples_gallery
choldgraf Apr 10, 2017
b571c51
calling it 'gallery'
choldgraf Apr 10, 2017
283f687
Remove plot_ suffix.
anntzer Apr 11, 2017
6763f83
sed source names and manual fixes
anntzer Apr 11, 2017
e01eb8d
Update .gitignore for s-g
anntzer Apr 11, 2017
356815a
Merge pull request #1 from anntzer/cleanup-plot_-prefix
choldgraf Apr 11, 2017
3f1ba02
fixing a couple links
choldgraf Apr 11, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,13 @@ lib/matplotlib/mpl-data/matplotlibrc

# Documentation generated files #
#################################
doc/api/_as_gen
doc/examples
# autogenerated by sphinx-gallery
doc/modules
doc/pyplots/tex_demo.png
doc/users/installing.rst
doc/_static/matplotlibrc
doc/pyplots/tex_demo.png
doc/api/_as_gen
lib/dateutil
examples/*/*.pdf
examples/*/*.png
Expand Down
7 changes: 3 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,9 @@

# Sphinx gallery configuration
sphinx_gallery_conf = {
# path to your examples scripts
'examples_dirs' : '../examples',
# path where to save gallery generated examples
'gallery_dirs' : 'gallery'}
'examples_dirs': '../examples',
'filename_pattern': '\.py$',
'gallery_dirs': 'gallery'}

plot_gallery = True

Expand Down
6 changes: 3 additions & 3 deletions doc/faq/howto_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ some ratio which controls the ratio::

.. htmlonly::

See :ref:`subplots_axes_and_figures-plot_equal_aspect_ratio` for a complete
See :ref:`subplots_axes_and_figures-equal_aspect_ratio` for a complete
example.


Expand Down Expand Up @@ -398,7 +398,7 @@ locators as desired because the two axes are independent.

.. htmlonly::

See :ref:`api-plot_two_scales` for a complete example
See :ref:`api-two_scales` for a complete example

.. _howto-batch:

Expand Down Expand Up @@ -644,7 +644,7 @@ For more on configuring your backend, see

Alternatively, you can avoid pylab/pyplot altogether, which will give
you a little more control, by calling the API directly as shown in
:ref:`api-plot_agg_oo`.
:ref:`api-agg_oo`.

You can either generate hardcopy on the filesystem by calling savefig::

Expand Down
8 changes: 4 additions & 4 deletions doc/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ def linkcheck():
FRONTPAGE_PY_PATH = "../examples/frontpage/" # python scripts location
FRONTPAGE_PNG_PATH = "_static/" # png files location
# png files and corresponding generation scripts:
FRONTPAGE_PNGS = {"surface3d_frontpage.png": "plot_3D.py",
"contour_frontpage.png": "plot_contour.py",
"histogram_frontpage.png": "plot_histogram.py",
"membrane_frontpage.png": "plot_membrane.py"}
FRONTPAGE_PNGS = {"surface3d_frontpage.png": "3D.py",
"contour_frontpage.png": "contour.py",
"histogram_frontpage.png": "histogram.py",
"membrane_frontpage.png": "membrane.py"}


def generate_frontpage_pngs(only_if_needed=True):
Expand Down
2 changes: 1 addition & 1 deletion doc/mpl_toolkits/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ plotting (scatter, surf, line, mesh) tools. Not the fastest or feature
complete 3D library out there, but ships with Matplotlib and thus may be a
lighter weight solution for some use cases.

.. plot:: gallery/mplot3d/plot_contourf3d_2.py
.. plot:: gallery/mplot3d/contourf3d_2.py

.. _toolkit_axes_grid1:

Expand Down
38 changes: 19 additions & 19 deletions doc/mpl_toolkits/mplot3d/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,41 +36,41 @@ Line plots
====================
.. automethod:: Axes3D.plot

.. plot:: gallery/mplot3d/plot_lines3d.py
.. plot:: gallery/mplot3d/lines3d.py

.. _scatter3d:

Scatter plots
=============
.. automethod:: Axes3D.scatter

.. plot:: gallery/mplot3d/plot_scatter3d.py
.. plot:: gallery/mplot3d/scatter3d.py

.. _wireframe:

Wireframe plots
===============
.. automethod:: Axes3D.plot_wireframe

.. plot:: gallery/mplot3d/plot_wire3d.py
.. plot:: gallery/mplot3d/wire3d.py

.. _surface:

Surface plots
=============
.. automethod:: Axes3D.plot_surface

.. plot:: gallery/mplot3d/plot_surface3d.py
.. plot:: gallery/mplot3d/plot_surface3d_2.py
.. plot:: gallery/mplot3d/plot_surface3d_3.py
.. plot:: gallery/mplot3d/surface3d.py
.. plot:: gallery/mplot3d/surface3d_2.py
.. plot:: gallery/mplot3d/surface3d_3.py

.. _trisurface:

Tri-Surface plots
=================
.. automethod:: Axes3D.plot_trisurf

.. plot:: gallery/mplot3d/plot_trisurf3d.py
.. plot:: gallery/mplot3d/trisurf3d.py


.. _contour3d:
Expand All @@ -79,18 +79,18 @@ Contour plots
=============
.. automethod:: Axes3D.contour

.. plot:: gallery/mplot3d/plot_contour3d.py
.. plot:: gallery/mplot3d/plot_contour3d_2.py
.. plot:: gallery/mplot3d/plot_contour3d_3.py
.. plot:: gallery/mplot3d/contour3d.py
.. plot:: gallery/mplot3d/contour3d_2.py
.. plot:: gallery/mplot3d/contour3d_3.py

.. _contourf3d:

Filled contour plots
====================
.. automethod:: Axes3D.contourf

.. plot:: gallery/mplot3d/plot_contourf3d.py
.. plot:: gallery/mplot3d/plot_contourf3d_2.py
.. plot:: gallery/mplot3d/contourf3d.py
.. plot:: gallery/mplot3d/contourf3d_2.py

.. versionadded:: 1.1.0
The feature demoed in the second contourf3d example was enabled as a
Expand All @@ -102,37 +102,37 @@ Polygon plots
====================
.. automethod:: Axes3D.add_collection3d

.. plot:: gallery/mplot3d/plot_polys3d.py
.. plot:: gallery/mplot3d/polys3d.py

.. _bar3d:

Bar plots
====================
.. automethod:: Axes3D.bar

.. plot:: gallery/mplot3d/plot_bars3d.py
.. plot:: gallery/mplot3d/bars3d.py

.. _quiver3d:

Quiver
====================
.. automethod:: Axes3D.quiver

.. plot:: gallery/mplot3d/plot_quiver3d.py
.. plot:: gallery/mplot3d/quiver3d.py

.. _2dcollections3d:

2D plots in 3D
====================
.. plot:: gallery/mplot3d/plot_2dcollections3d.py
.. plot:: gallery/mplot3d/2dcollections3d.py

.. _text3d:

Text
====================
.. automethod:: Axes3D.text

.. plot:: gallery/mplot3d/plot_text3d.py
.. plot:: gallery/mplot3d/text3d.py

.. _3dsubplots:

Expand All @@ -146,5 +146,5 @@ in the same figure.
Subplotting 3D plots was added in v1.0.0. Earlier version can not
do this.

.. plot:: gallery/mplot3d/plot_subplot3d.py
.. plot:: gallery/mplot3d/plot_mixed_subplots.py
.. plot:: gallery/mplot3d/subplot3d.py
.. plot:: gallery/mplot3d/mixed_subplots.py
4 changes: 2 additions & 2 deletions doc/users/legend_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,8 @@ Known examples of using legend
Here is a non-exhaustive list of the examples available involving legend
being used in various ways:

* :ref:`api-plot_legend`
* :ref:`lines_bars_and_markers-plot_scatter_with_legend`
* :ref:`api-legend`
* :ref:`lines_bars_and_markers-scatter_with_legend`
* :ref:`pylab_examples-contourf_hatching`
* :ref:`pylab_examples-figlegend_demo`
* :ref:`pylab_examples-scatter_symbol`
12 changes: 6 additions & 6 deletions doc/users/prev_whats_new/whats_new_1.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Sankey Diagrams

Kevin Davies has extended Yannick Copin's original Sankey example into a module
(:mod:`~matplotlib.sankey`) and provided new examples
(:ref:`api-plot_sankey_basics`, :ref:`api-plot_sankey_links`,
:ref:`api-plot_sankey_rankine`).
(:ref:`api-sankey_basics`, :ref:`api-sankey_links`,
:ref:`api-sankey_rankine`).

.. plot:: gallery/api/plot_sankey_rankine.py
.. plot:: gallery/api/sankey_rankine.py


Animation
Expand Down Expand Up @@ -135,12 +135,12 @@ as 2D plotting, Ben Root has made several improvements to the

* Ticker offset display added:

.. plot:: gallery/mplot3d/plot_offset.py
.. plot:: gallery/mplot3d/offset.py

* :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
gains *zdir* and *offset* kwargs. You can now do this:

.. plot:: gallery/mplot3d/plot_contourf3d_2.py
.. plot:: gallery/mplot3d/contourf3d_2.py

Numerix support removed
-----------------------
Expand Down Expand Up @@ -205,6 +205,6 @@ Other improvements

* Pim Schellart added a new colormap called "cubehelix".
Sameer Grover also added a colormap called "coolwarm". See it and all
other colormaps :ref:`here <color-plot_colormaps_reference>`.
other colormaps :ref:`here <color-colormaps_reference>`.

* Many bug fixes and documentation improvements.
4 changes: 2 additions & 2 deletions doc/users/prev_whats_new/whats_new_1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Damon McDougall added a new plotting method for the
:mod:`~mpl_toolkits.mplot3d` toolkit called
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf`.

.. plot:: gallery/mplot3d/plot_trisurf3d.py
.. plot:: gallery/mplot3d/trisurf3d.py

Control the lengths of colorbar extensions
------------------------------------------
Expand Down Expand Up @@ -153,7 +153,7 @@ In addition to simply plotting the streamlines of the vector field,
line widths of the streamlines to a separate parameter, such as the speed or
local intensity of the vector field.

.. plot:: gallery/images_contours_and_fields/plot_streamplot_features.py
.. plot:: gallery/images_contours_and_fields/streamplot_features.py


New hist functionality
Expand Down
4 changes: 2 additions & 2 deletions doc/users/prev_whats_new/whats_new_1.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ before creating your plot. For really fine control, it is also possible
to modify each artist's sketch parameters individually with
:meth:`matplotlib.artist.Artist.set_sketch_params`.

.. plot:: gallery/showcase/plot_xkcd.py
.. plot:: gallery/showcase/xkcd.py

Updated Axes3D.contour methods
------------------------------
Expand All @@ -100,7 +100,7 @@ Damon McDougall updated the
:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.tricontourf` methods to allow 3D
contour plots on abitrary unstructured user-specified triangulations.

.. plot:: gallery/mplot3d/plot_tricontour3d.py
.. plot:: gallery/mplot3d/tricontour3d.py

New eventplot plot type
```````````````````````
Expand Down
8 changes: 4 additions & 4 deletions doc/users/prev_whats_new/whats_new_1.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ with :func:`~matplotlib.Axes.bxp`.
Lastly, each artist (e.g., the box, outliers, cap, notches) can now be
toggled on or off and their styles can be passed in through individual
kwargs. See the examples:
:ref:`statistics-plot_boxplot` and
:ref:`statistics-plot_bxp`
:ref:`statistics-boxplot` and
:ref:`statistics-bxp`

Added a bool kwarg, :code:`manage_xticks`, which if False disables the management
of the ticks and limits on the x-axis by :func:`~matplotlib.axes.Axes.bxp`.
Expand Down Expand Up @@ -160,7 +160,7 @@ matplotlib internals were cleaned up to support using such transforms in
:class:`~matplotlib.Axes`. This transform is important for some plot types,
specifically the Skew-T used in meteorology.

.. plot:: gallery/api/plot_skewt.py
.. plot:: gallery/api/skewt.py

Support for specifying properties of wedge and text in pie charts.
``````````````````````````````````````````````````````````````````
Expand Down Expand Up @@ -243,7 +243,7 @@ term project. This feature is documented in :func:`~mpl_toolkits.mplot3d.Axes3D.
The team members are: Ryan Steve D'Souza, Victor B, xbtsw, Yang Wang, David,
Caradec Bisesar and Vlad Vassilovski.

.. plot:: gallery/mplot3d/plot_quiver3d.py
.. plot:: gallery/mplot3d/quiver3d.py

polar-plot r-tick locations
```````````````````````````
Expand Down
4 changes: 2 additions & 2 deletions doc/users/prev_whats_new/whats_new_1.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ You can even multiply cyclers, which is like using `itertools.product()`
on two or more property cycles. Remember to use parentheses if writing
a multi-line `prop_cycle` parameter.

.. plot:: gallery/color/plot_color_cycle.py
.. plot:: gallery/color/color_cycle.py


New Colormaps
Expand Down Expand Up @@ -367,7 +367,7 @@ kwargs names is not ideal, but `Axes.fill_between` already has a

This is particularly useful for plotting pre-binned histograms.

.. plot:: gallery/api/plot_filled_step.py
.. plot:: gallery/api/filled_step.py


Square Plot
Expand Down
Loading