From 8473c69428def4383834c12003027e95445e6631 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Wed, 3 Mar 2021 06:49:03 +0000 Subject: [PATCH 01/20] Reorganize gallery examples --- examples/gallery/3d-plots/README.txt | 2 ++ examples/gallery/{grid => 3d-plots}/grdview_surface.py | 0 examples/gallery/{plot => 3d-plots}/scatter3d.py | 0 examples/gallery/coast/README.txt | 2 -- examples/gallery/grid/README.txt | 2 -- examples/gallery/line/README.txt | 4 ++-- examples/gallery/maps/README.txt | 2 ++ examples/gallery/{coast => maps}/borders.py | 0 examples/gallery/{plot => maps}/colorbar.py | 0 examples/gallery/{plot => maps}/inset.py | 0 examples/gallery/{coast => maps}/land_and_water.py | 0 examples/gallery/{plot => maps}/legend.py | 0 examples/gallery/{plot => maps}/meca.py | 0 examples/gallery/{coast => maps}/shorelines.py | 0 examples/gallery/{grid => maps}/track_sampling.py | 0 examples/gallery/plot/README.txt | 2 -- examples/gallery/symbols/README.txt | 2 ++ examples/gallery/{plot => symbols}/datetime-inputs.py | 0 examples/gallery/{plot => symbols}/image.py | 0 examples/gallery/{plot => symbols}/logo.py | 0 examples/gallery/{plot => symbols}/multi-parameter-symbols.py | 0 examples/gallery/{plot => symbols}/points-transparency.py | 0 examples/gallery/{plot => symbols}/points.py | 0 examples/gallery/{plot => symbols}/scatter.py | 0 24 files changed, 8 insertions(+), 8 deletions(-) create mode 100644 examples/gallery/3d-plots/README.txt rename examples/gallery/{grid => 3d-plots}/grdview_surface.py (100%) rename examples/gallery/{plot => 3d-plots}/scatter3d.py (100%) delete mode 100644 examples/gallery/coast/README.txt delete mode 100644 examples/gallery/grid/README.txt create mode 100644 examples/gallery/maps/README.txt rename examples/gallery/{coast => maps}/borders.py (100%) rename examples/gallery/{plot => maps}/colorbar.py (100%) rename examples/gallery/{plot => maps}/inset.py (100%) rename examples/gallery/{coast => maps}/land_and_water.py (100%) rename examples/gallery/{plot => maps}/legend.py (100%) rename examples/gallery/{plot => maps}/meca.py (100%) rename examples/gallery/{coast => maps}/shorelines.py (100%) rename examples/gallery/{grid => maps}/track_sampling.py (100%) delete mode 100644 examples/gallery/plot/README.txt create mode 100644 examples/gallery/symbols/README.txt rename examples/gallery/{plot => symbols}/datetime-inputs.py (100%) rename examples/gallery/{plot => symbols}/image.py (100%) rename examples/gallery/{plot => symbols}/logo.py (100%) rename examples/gallery/{plot => symbols}/multi-parameter-symbols.py (100%) rename examples/gallery/{plot => symbols}/points-transparency.py (100%) rename examples/gallery/{plot => symbols}/points.py (100%) rename examples/gallery/{plot => symbols}/scatter.py (100%) diff --git a/examples/gallery/3d-plots/README.txt b/examples/gallery/3d-plots/README.txt new file mode 100644 index 00000000000..580c258215f --- /dev/null +++ b/examples/gallery/3d-plots/README.txt @@ -0,0 +1,2 @@ +3D Plots +-------- diff --git a/examples/gallery/grid/grdview_surface.py b/examples/gallery/3d-plots/grdview_surface.py similarity index 100% rename from examples/gallery/grid/grdview_surface.py rename to examples/gallery/3d-plots/grdview_surface.py diff --git a/examples/gallery/plot/scatter3d.py b/examples/gallery/3d-plots/scatter3d.py similarity index 100% rename from examples/gallery/plot/scatter3d.py rename to examples/gallery/3d-plots/scatter3d.py diff --git a/examples/gallery/coast/README.txt b/examples/gallery/coast/README.txt deleted file mode 100644 index a45d2747e61..00000000000 --- a/examples/gallery/coast/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Coastlines and boundaries -------------------------- diff --git a/examples/gallery/grid/README.txt b/examples/gallery/grid/README.txt deleted file mode 100644 index 6fd2c9aea1a..00000000000 --- a/examples/gallery/grid/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Grids ------ diff --git a/examples/gallery/line/README.txt b/examples/gallery/line/README.txt index 043f6ca6a79..8e2076a6c6d 100644 --- a/examples/gallery/line/README.txt +++ b/examples/gallery/line/README.txt @@ -1,2 +1,2 @@ -Lines ------ +Lines and vectors +----------------- diff --git a/examples/gallery/maps/README.txt b/examples/gallery/maps/README.txt new file mode 100644 index 00000000000..b1a00a492fb --- /dev/null +++ b/examples/gallery/maps/README.txt @@ -0,0 +1,2 @@ +Maps and map elements +--------------------- diff --git a/examples/gallery/coast/borders.py b/examples/gallery/maps/borders.py similarity index 100% rename from examples/gallery/coast/borders.py rename to examples/gallery/maps/borders.py diff --git a/examples/gallery/plot/colorbar.py b/examples/gallery/maps/colorbar.py similarity index 100% rename from examples/gallery/plot/colorbar.py rename to examples/gallery/maps/colorbar.py diff --git a/examples/gallery/plot/inset.py b/examples/gallery/maps/inset.py similarity index 100% rename from examples/gallery/plot/inset.py rename to examples/gallery/maps/inset.py diff --git a/examples/gallery/coast/land_and_water.py b/examples/gallery/maps/land_and_water.py similarity index 100% rename from examples/gallery/coast/land_and_water.py rename to examples/gallery/maps/land_and_water.py diff --git a/examples/gallery/plot/legend.py b/examples/gallery/maps/legend.py similarity index 100% rename from examples/gallery/plot/legend.py rename to examples/gallery/maps/legend.py diff --git a/examples/gallery/plot/meca.py b/examples/gallery/maps/meca.py similarity index 100% rename from examples/gallery/plot/meca.py rename to examples/gallery/maps/meca.py diff --git a/examples/gallery/coast/shorelines.py b/examples/gallery/maps/shorelines.py similarity index 100% rename from examples/gallery/coast/shorelines.py rename to examples/gallery/maps/shorelines.py diff --git a/examples/gallery/grid/track_sampling.py b/examples/gallery/maps/track_sampling.py similarity index 100% rename from examples/gallery/grid/track_sampling.py rename to examples/gallery/maps/track_sampling.py diff --git a/examples/gallery/plot/README.txt b/examples/gallery/plot/README.txt deleted file mode 100644 index c213e06feea..00000000000 --- a/examples/gallery/plot/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Plotting map items ------------------- diff --git a/examples/gallery/symbols/README.txt b/examples/gallery/symbols/README.txt new file mode 100644 index 00000000000..cec30d21b2c --- /dev/null +++ b/examples/gallery/symbols/README.txt @@ -0,0 +1,2 @@ +Images, symbols, and markers +---------------------------- diff --git a/examples/gallery/plot/datetime-inputs.py b/examples/gallery/symbols/datetime-inputs.py similarity index 100% rename from examples/gallery/plot/datetime-inputs.py rename to examples/gallery/symbols/datetime-inputs.py diff --git a/examples/gallery/plot/image.py b/examples/gallery/symbols/image.py similarity index 100% rename from examples/gallery/plot/image.py rename to examples/gallery/symbols/image.py diff --git a/examples/gallery/plot/logo.py b/examples/gallery/symbols/logo.py similarity index 100% rename from examples/gallery/plot/logo.py rename to examples/gallery/symbols/logo.py diff --git a/examples/gallery/plot/multi-parameter-symbols.py b/examples/gallery/symbols/multi-parameter-symbols.py similarity index 100% rename from examples/gallery/plot/multi-parameter-symbols.py rename to examples/gallery/symbols/multi-parameter-symbols.py diff --git a/examples/gallery/plot/points-transparency.py b/examples/gallery/symbols/points-transparency.py similarity index 100% rename from examples/gallery/plot/points-transparency.py rename to examples/gallery/symbols/points-transparency.py diff --git a/examples/gallery/plot/points.py b/examples/gallery/symbols/points.py similarity index 100% rename from examples/gallery/plot/points.py rename to examples/gallery/symbols/points.py diff --git a/examples/gallery/plot/scatter.py b/examples/gallery/symbols/scatter.py similarity index 100% rename from examples/gallery/plot/scatter.py rename to examples/gallery/symbols/scatter.py From 8ba8cb018b40665535fe75e9791a276a52a36138 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Wed, 3 Mar 2021 20:26:35 +0000 Subject: [PATCH 02/20] Update conf.py --- doc/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 9583ed7f8a4..56d8fa04ee4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -71,10 +71,10 @@ "gallery_dirs": ["gallery", "tutorials", "projections"], "subsection_order": ExplicitOrder( [ + "../examples/gallery/maps", "../examples/gallery/line", - "../examples/gallery/coast", - "../examples/gallery/plot", - "../examples/gallery/grid", + "../examples/gallery/symbols", + "../examples/gallery/3d-plots", "../examples/projections/azim", "../examples/projections/conic", "../examples/projections/cyl", From c4ab0897e2c1bcd2ab63ca5d401a2fc6ed4bd112 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Thu, 4 Mar 2021 19:41:21 +0000 Subject: [PATCH 03/20] Changing "line" to "lines" --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 56d8fa04ee4..b8d83261e3b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -72,7 +72,7 @@ "subsection_order": ExplicitOrder( [ "../examples/gallery/maps", - "../examples/gallery/line", + "../examples/gallery/lines", "../examples/gallery/symbols", "../examples/gallery/3d-plots", "../examples/projections/azim", From 3639b5016f2e537cd751ef5c69a5b36b3f1a8660 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Fri, 5 Mar 2021 07:52:29 +0000 Subject: [PATCH 04/20] Rename folder from "line" to "lines" --- examples/gallery/{line => lines}/README.txt | 0 examples/gallery/{line => lines}/line-custom-cpt.py | 0 examples/gallery/{line => lines}/linestyles.py | 0 examples/gallery/{line => lines}/vector-heads-tails.py | 2 +- examples/gallery/{line => lines}/vectors.py | 0 5 files changed, 1 insertion(+), 1 deletion(-) rename examples/gallery/{line => lines}/README.txt (100%) rename examples/gallery/{line => lines}/line-custom-cpt.py (100%) rename examples/gallery/{line => lines}/linestyles.py (100%) rename examples/gallery/{line => lines}/vector-heads-tails.py (98%) rename examples/gallery/{line => lines}/vectors.py (100%) diff --git a/examples/gallery/line/README.txt b/examples/gallery/lines/README.txt similarity index 100% rename from examples/gallery/line/README.txt rename to examples/gallery/lines/README.txt diff --git a/examples/gallery/line/line-custom-cpt.py b/examples/gallery/lines/line-custom-cpt.py similarity index 100% rename from examples/gallery/line/line-custom-cpt.py rename to examples/gallery/lines/line-custom-cpt.py diff --git a/examples/gallery/line/linestyles.py b/examples/gallery/lines/linestyles.py similarity index 100% rename from examples/gallery/line/linestyles.py rename to examples/gallery/lines/linestyles.py diff --git a/examples/gallery/line/vector-heads-tails.py b/examples/gallery/lines/vector-heads-tails.py similarity index 98% rename from examples/gallery/line/vector-heads-tails.py rename to examples/gallery/lines/vector-heads-tails.py index 366ee58beda..7c213f73006 100644 --- a/examples/gallery/line/vector-heads-tails.py +++ b/examples/gallery/lines/vector-heads-tails.py @@ -26,7 +26,7 @@ In the following we use the :meth:`pygmt.Figure.plot` method to plot vectors with individual heads and tails. We must specify the modifiers (together with the vector type, here ``v``, see also -:doc:`Vector types documentation `) +:doc:`Vector types documentation `) by passing the corresponding shortcuts to the ``style`` parameter. """ diff --git a/examples/gallery/line/vectors.py b/examples/gallery/lines/vectors.py similarity index 100% rename from examples/gallery/line/vectors.py rename to examples/gallery/lines/vectors.py From 965dbf3a50dabcf519aff97a213b14139e4ab7a9 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Fri, 5 Mar 2021 07:53:31 +0000 Subject: [PATCH 05/20] Rename inset.py tutorial example to inset-tutorial.py --- examples/tutorials/{inset.py => inset-tutorial.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/tutorials/{inset.py => inset-tutorial.py} (100%) diff --git a/examples/tutorials/inset.py b/examples/tutorials/inset-tutorial.py similarity index 100% rename from examples/tutorials/inset.py rename to examples/tutorials/inset-tutorial.py From 5ebef74b7fbf76c68e42b30fe5ff05f7356e6e19 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 7 Mar 2021 17:44:47 +0000 Subject: [PATCH 06/20] Change sort for gallery --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index b8d83261e3b..dfd055ce40f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -88,7 +88,7 @@ # Remove the "Download all examples" button from the top level gallery "download_all_examples": False, # Sort gallery example by file name instead of number of lines (default) - "within_subsection_order": FileNameSortKey, + "within_subsection_order": ExampleTitleSortKey, # directory where function granular galleries are stored "backreferences_dir": "api/generated/backreferences", # Modules for which function level galleries are created. In From 9c7be5570f5043190307d20738b67db23a49fb92 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 7 Mar 2021 17:50:18 +0000 Subject: [PATCH 07/20] Add image and contour gallery --- doc/conf.py | 1 + examples/gallery/images/README.txt | 2 ++ examples/gallery/{symbols => images}/image.py | 0 3 files changed, 3 insertions(+) create mode 100644 examples/gallery/images/README.txt rename examples/gallery/{symbols => images}/image.py (100%) diff --git a/doc/conf.py b/doc/conf.py index dfd055ce40f..ae1686d0b60 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -71,6 +71,7 @@ "gallery_dirs": ["gallery", "tutorials", "projections"], "subsection_order": ExplicitOrder( [ + "../examples/gallery/images", "../examples/gallery/maps", "../examples/gallery/lines", "../examples/gallery/symbols", diff --git a/examples/gallery/images/README.txt b/examples/gallery/images/README.txt new file mode 100644 index 00000000000..4567e7d13b3 --- /dev/null +++ b/examples/gallery/images/README.txt @@ -0,0 +1,2 @@ +Images and contours +------------------- diff --git a/examples/gallery/symbols/image.py b/examples/gallery/images/image.py similarity index 100% rename from examples/gallery/symbols/image.py rename to examples/gallery/images/image.py From c317fb7578bf709f7c77eb16741c87cb95fd9523 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 7 Mar 2021 17:52:24 +0000 Subject: [PATCH 08/20] Update import statement --- doc/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/conf.py b/doc/conf.py index ae1686d0b60..3f7acf112cc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -10,6 +10,7 @@ from sphinx_gallery.sorting import ( # pylint: disable=no-name-in-module ExplicitOrder, FileNameSortKey, + ExampleTitleSortKey, ) from pygmt import __commit__, __version__ from pygmt.sphinx_gallery import PyGMTScraper From c433af91444c50ad9223a88ee36148b6a8fb1edb Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sun, 7 Mar 2021 17:53:56 +0000 Subject: [PATCH 09/20] Remove unused import --- doc/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 3f7acf112cc..4577f120d58 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -9,7 +9,6 @@ # isort: off from sphinx_gallery.sorting import ( # pylint: disable=no-name-in-module ExplicitOrder, - FileNameSortKey, ExampleTitleSortKey, ) from pygmt import __commit__, __version__ From 7e56d9fef02810b45b11e90d55545bba5fd70529 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Mon, 8 Mar 2021 14:00:27 +0000 Subject: [PATCH 10/20] Update doc/conf.py Co-authored-by: Dongdong Tian --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 4577f120d58..7da7876647c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -71,10 +71,10 @@ "gallery_dirs": ["gallery", "tutorials", "projections"], "subsection_order": ExplicitOrder( [ - "../examples/gallery/images", "../examples/gallery/maps", "../examples/gallery/lines", "../examples/gallery/symbols", + "../examples/gallery/images", "../examples/gallery/3d-plots", "../examples/projections/azim", "../examples/projections/conic", From 897cf570348ff65012458a9e904ad4f3bb3b7214 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Tue, 9 Mar 2021 06:56:10 +0000 Subject: [PATCH 11/20] Update examples/gallery/symbols/README.txt Co-authored-by: Dongdong Tian --- examples/gallery/symbols/README.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/gallery/symbols/README.txt b/examples/gallery/symbols/README.txt index cec30d21b2c..8d8d751404e 100644 --- a/examples/gallery/symbols/README.txt +++ b/examples/gallery/symbols/README.txt @@ -1,2 +1,2 @@ -Images, symbols, and markers ----------------------------- +Symbols and markers +------------------- From b2d21a395d3686897222916ef921a20f9bb801f1 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Tue, 9 Mar 2021 06:58:41 +0000 Subject: [PATCH 12/20] move logo.py and track_sampling.py to images gallery folder --- examples/gallery/{symbols => images}/logo.py | 0 examples/gallery/{maps => images}/track_sampling.py | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename examples/gallery/{symbols => images}/logo.py (100%) rename examples/gallery/{maps => images}/track_sampling.py (100%) diff --git a/examples/gallery/symbols/logo.py b/examples/gallery/images/logo.py similarity index 100% rename from examples/gallery/symbols/logo.py rename to examples/gallery/images/logo.py diff --git a/examples/gallery/maps/track_sampling.py b/examples/gallery/images/track_sampling.py similarity index 100% rename from examples/gallery/maps/track_sampling.py rename to examples/gallery/images/track_sampling.py From 4b1bb78343996f1bb20cc0f174bbe7d250f389c7 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Tue, 9 Mar 2021 07:01:18 +0000 Subject: [PATCH 13/20] Replace underscores with hyphens in file names for gallery examples --- .../gallery/3d-plots/{grdview_surface.py => grdview-surface.py} | 0 examples/gallery/images/{track_sampling.py => track-sampling.py} | 0 examples/gallery/maps/{land_and_water.py => land-and-water.py} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename examples/gallery/3d-plots/{grdview_surface.py => grdview-surface.py} (100%) rename examples/gallery/images/{track_sampling.py => track-sampling.py} (100%) rename examples/gallery/maps/{land_and_water.py => land-and-water.py} (100%) diff --git a/examples/gallery/3d-plots/grdview_surface.py b/examples/gallery/3d-plots/grdview-surface.py similarity index 100% rename from examples/gallery/3d-plots/grdview_surface.py rename to examples/gallery/3d-plots/grdview-surface.py diff --git a/examples/gallery/images/track_sampling.py b/examples/gallery/images/track-sampling.py similarity index 100% rename from examples/gallery/images/track_sampling.py rename to examples/gallery/images/track-sampling.py diff --git a/examples/gallery/maps/land_and_water.py b/examples/gallery/maps/land-and-water.py similarity index 100% rename from examples/gallery/maps/land_and_water.py rename to examples/gallery/maps/land-and-water.py From 363b54bfabf7efc6e0fc1662b37bc67ae560e2ff Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Thu, 11 Mar 2021 06:43:50 +0000 Subject: [PATCH 14/20] Replace hyphens with underscores --- .../gallery/3d-plots/{grdview-surface.py => grdview_surface.py} | 0 examples/gallery/images/{track-sampling.py => track_sampling.py} | 0 examples/gallery/maps/{land-and-water.py => land_and_water.py} | 0 .../gallery/symbols/{datetime-inputs.py => datetime_inputs.py} | 0 .../{multi-parameter-symbols.py => multi_parameter_symbols.py} | 0 .../symbols/{points-transparency.py => points_transparency.py} | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename examples/gallery/3d-plots/{grdview-surface.py => grdview_surface.py} (100%) rename examples/gallery/images/{track-sampling.py => track_sampling.py} (100%) rename examples/gallery/maps/{land-and-water.py => land_and_water.py} (100%) rename examples/gallery/symbols/{datetime-inputs.py => datetime_inputs.py} (100%) rename examples/gallery/symbols/{multi-parameter-symbols.py => multi_parameter_symbols.py} (100%) rename examples/gallery/symbols/{points-transparency.py => points_transparency.py} (100%) diff --git a/examples/gallery/3d-plots/grdview-surface.py b/examples/gallery/3d-plots/grdview_surface.py similarity index 100% rename from examples/gallery/3d-plots/grdview-surface.py rename to examples/gallery/3d-plots/grdview_surface.py diff --git a/examples/gallery/images/track-sampling.py b/examples/gallery/images/track_sampling.py similarity index 100% rename from examples/gallery/images/track-sampling.py rename to examples/gallery/images/track_sampling.py diff --git a/examples/gallery/maps/land-and-water.py b/examples/gallery/maps/land_and_water.py similarity index 100% rename from examples/gallery/maps/land-and-water.py rename to examples/gallery/maps/land_and_water.py diff --git a/examples/gallery/symbols/datetime-inputs.py b/examples/gallery/symbols/datetime_inputs.py similarity index 100% rename from examples/gallery/symbols/datetime-inputs.py rename to examples/gallery/symbols/datetime_inputs.py diff --git a/examples/gallery/symbols/multi-parameter-symbols.py b/examples/gallery/symbols/multi_parameter_symbols.py similarity index 100% rename from examples/gallery/symbols/multi-parameter-symbols.py rename to examples/gallery/symbols/multi_parameter_symbols.py diff --git a/examples/gallery/symbols/points-transparency.py b/examples/gallery/symbols/points_transparency.py similarity index 100% rename from examples/gallery/symbols/points-transparency.py rename to examples/gallery/symbols/points_transparency.py From e2b60073eb9895ad539862e5e4debc576ad68e78 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Thu, 11 Mar 2021 06:51:05 +0000 Subject: [PATCH 15/20] Reorganize galleries --- doc/conf.py | 2 ++ examples/gallery/embellishments/README.txt | 2 ++ examples/gallery/{maps => embellishments}/colorbar.py | 0 examples/gallery/{maps => embellishments}/inset.py | 0 examples/gallery/{maps => embellishments}/legend.py | 0 examples/gallery/{images => embellishments}/logo.py | 0 examples/gallery/images/README.txt | 4 ++-- examples/gallery/seismology/README.txt | 2 ++ examples/gallery/{maps => seismology}/meca.py | 0 9 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 examples/gallery/embellishments/README.txt rename examples/gallery/{maps => embellishments}/colorbar.py (100%) rename examples/gallery/{maps => embellishments}/inset.py (100%) rename examples/gallery/{maps => embellishments}/legend.py (100%) rename examples/gallery/{images => embellishments}/logo.py (100%) create mode 100644 examples/gallery/seismology/README.txt rename examples/gallery/{maps => seismology}/meca.py (100%) diff --git a/doc/conf.py b/doc/conf.py index 7da7876647c..4ecb4ff2a85 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -76,6 +76,8 @@ "../examples/gallery/symbols", "../examples/gallery/images", "../examples/gallery/3d-plots", + "../examples/gallery/seismology", + "../examples/gallery/embellishments", "../examples/projections/azim", "../examples/projections/conic", "../examples/projections/cyl", diff --git a/examples/gallery/embellishments/README.txt b/examples/gallery/embellishments/README.txt new file mode 100644 index 00000000000..3a6e2b21482 --- /dev/null +++ b/examples/gallery/embellishments/README.txt @@ -0,0 +1,2 @@ +Plot embellishments +------------------- diff --git a/examples/gallery/maps/colorbar.py b/examples/gallery/embellishments/colorbar.py similarity index 100% rename from examples/gallery/maps/colorbar.py rename to examples/gallery/embellishments/colorbar.py diff --git a/examples/gallery/maps/inset.py b/examples/gallery/embellishments/inset.py similarity index 100% rename from examples/gallery/maps/inset.py rename to examples/gallery/embellishments/inset.py diff --git a/examples/gallery/maps/legend.py b/examples/gallery/embellishments/legend.py similarity index 100% rename from examples/gallery/maps/legend.py rename to examples/gallery/embellishments/legend.py diff --git a/examples/gallery/images/logo.py b/examples/gallery/embellishments/logo.py similarity index 100% rename from examples/gallery/images/logo.py rename to examples/gallery/embellishments/logo.py diff --git a/examples/gallery/images/README.txt b/examples/gallery/images/README.txt index 4567e7d13b3..3375172a820 100644 --- a/examples/gallery/images/README.txt +++ b/examples/gallery/images/README.txt @@ -1,2 +1,2 @@ -Images and contours -------------------- +Images, contours, and fields +---------------------------- diff --git a/examples/gallery/seismology/README.txt b/examples/gallery/seismology/README.txt new file mode 100644 index 00000000000..9f247d8f474 --- /dev/null +++ b/examples/gallery/seismology/README.txt @@ -0,0 +1,2 @@ +Seismology and geodesy +---------------------- diff --git a/examples/gallery/maps/meca.py b/examples/gallery/seismology/meca.py similarity index 100% rename from examples/gallery/maps/meca.py rename to examples/gallery/seismology/meca.py From f9536322f5ea70052d3de5d26803c28bbf27b61a Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 11 Mar 2021 10:40:04 -0500 Subject: [PATCH 16/20] Rename two files using underscores --- examples/gallery/lines/{line-custom-cpt.py => line_custom_cpt.py} | 0 .../lines/{vector-heads-tails.py => vector_heads_tails.py} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename examples/gallery/lines/{line-custom-cpt.py => line_custom_cpt.py} (100%) rename examples/gallery/lines/{vector-heads-tails.py => vector_heads_tails.py} (100%) diff --git a/examples/gallery/lines/line-custom-cpt.py b/examples/gallery/lines/line_custom_cpt.py similarity index 100% rename from examples/gallery/lines/line-custom-cpt.py rename to examples/gallery/lines/line_custom_cpt.py diff --git a/examples/gallery/lines/vector-heads-tails.py b/examples/gallery/lines/vector_heads_tails.py similarity index 100% rename from examples/gallery/lines/vector-heads-tails.py rename to examples/gallery/lines/vector_heads_tails.py From e0e507dc665626d4c6b3dac6278556592f0a09ab Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 11 Mar 2021 10:42:00 -0500 Subject: [PATCH 17/20] Rename inset-tutorial.py to insets.py --- examples/tutorials/{inset-tutorial.py => insets.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/tutorials/{inset-tutorial.py => insets.py} (100%) diff --git a/examples/tutorials/inset-tutorial.py b/examples/tutorials/insets.py similarity index 100% rename from examples/tutorials/inset-tutorial.py rename to examples/tutorials/insets.py From f6622f8d4ee3934eb631262317b7e9fcadc583cc Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 11 Mar 2021 11:38:55 -0500 Subject: [PATCH 18/20] Update references in examples --- examples/gallery/lines/vectors.py | 2 +- examples/tutorials/lines.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/gallery/lines/vectors.py b/examples/gallery/lines/vectors.py index 480cd9cb89b..7dc6d7042f9 100644 --- a/examples/gallery/lines/vectors.py +++ b/examples/gallery/lines/vectors.py @@ -4,7 +4,7 @@ The :meth:`pygmt.Figure.plot` method can plot Cartesian, circular, and geographic vectors. The ``style`` parameter controls vector attributes. See also -:doc:`Vector attributes documentation `. +:doc:`Vector attributes documentation `. """ import numpy as np diff --git a/examples/tutorials/lines.py b/examples/tutorials/lines.py index a7340371aee..c844367cacb 100644 --- a/examples/tutorials/lines.py +++ b/examples/tutorials/lines.py @@ -125,7 +125,7 @@ # example below, the line width is set to ``7p``, the color is set to ``green``, and the # line style is ``-.-`` (*dash dot dash*). # -# For a gallery showing other ``pen`` settings, see :doc:`/gallery/line/linestyles`. +# For a gallery showing other ``pen`` settings, see :doc:`/gallery/lines/linestyles`. fig = pygmt.Figure() fig.plot( From e3c8c10aca3bfe94120966f6179b39e83b689336 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 11 Mar 2021 11:57:06 -0500 Subject: [PATCH 19/20] Rename 3d-plots to 3d_plots --- doc/conf.py | 2 +- examples/gallery/{3d-plots => 3d_plots}/README.txt | 0 examples/gallery/{3d-plots => 3d_plots}/grdview_surface.py | 0 examples/gallery/{3d-plots => 3d_plots}/scatter3d.py | 0 4 files changed, 1 insertion(+), 1 deletion(-) rename examples/gallery/{3d-plots => 3d_plots}/README.txt (100%) rename examples/gallery/{3d-plots => 3d_plots}/grdview_surface.py (100%) rename examples/gallery/{3d-plots => 3d_plots}/scatter3d.py (100%) diff --git a/doc/conf.py b/doc/conf.py index 4ecb4ff2a85..25d044bdac4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -75,7 +75,7 @@ "../examples/gallery/lines", "../examples/gallery/symbols", "../examples/gallery/images", - "../examples/gallery/3d-plots", + "../examples/gallery/3d_plots", "../examples/gallery/seismology", "../examples/gallery/embellishments", "../examples/projections/azim", diff --git a/examples/gallery/3d-plots/README.txt b/examples/gallery/3d_plots/README.txt similarity index 100% rename from examples/gallery/3d-plots/README.txt rename to examples/gallery/3d_plots/README.txt diff --git a/examples/gallery/3d-plots/grdview_surface.py b/examples/gallery/3d_plots/grdview_surface.py similarity index 100% rename from examples/gallery/3d-plots/grdview_surface.py rename to examples/gallery/3d_plots/grdview_surface.py diff --git a/examples/gallery/3d-plots/scatter3d.py b/examples/gallery/3d_plots/scatter3d.py similarity index 100% rename from examples/gallery/3d-plots/scatter3d.py rename to examples/gallery/3d_plots/scatter3d.py From ce706f45604f97f522746700a7616f4bd22fd802 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 11 Mar 2021 12:10:24 -0500 Subject: [PATCH 20/20] Fix a broken reference to inset.py --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 7dcc11b8953..dbb64e0c822 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -38,7 +38,7 @@ tutorials/contour-map.rst tutorials/earth-relief.rst tutorials/3d-perspective-image.rst - tutorials/inset.rst + tutorials/insets.rst tutorials/subplots.rst tutorials/configuration.rst