Skip to content
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.

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

Reorganize gallery examples #995

Merged
merged 31 commits into from
Mar 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
8473c69
Reorganize gallery examples
willschlitzer Mar 3, 2021
b63a481
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 3, 2021
8ba8cb0
Update conf.py
willschlitzer Mar 3, 2021
77e377f
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 3, 2021
c4ab089
Changing "line" to "lines"
willschlitzer Mar 4, 2021
f7c2d3c
Merge remote-tracking branch 'origin/reorganize-gallery' into reorgan…
willschlitzer Mar 4, 2021
3639b50
Rename folder from "line" to "lines"
willschlitzer Mar 5, 2021
965dbf3
Rename inset.py tutorial example to inset-tutorial.py
willschlitzer Mar 5, 2021
642d9c2
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 5, 2021
5ebef74
Change sort for gallery
willschlitzer Mar 7, 2021
9c7be55
Add image and contour gallery
willschlitzer Mar 7, 2021
4ad94d0
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 7, 2021
c317fb7
Update import statement
willschlitzer Mar 7, 2021
c433af9
Remove unused import
willschlitzer Mar 7, 2021
7e56d9f
Update doc/conf.py
willschlitzer Mar 8, 2021
897cf57
Update examples/gallery/symbols/README.txt
willschlitzer Mar 9, 2021
b2d21a3
move logo.py and track_sampling.py to images gallery folder
willschlitzer Mar 9, 2021
7fa38ac
Merge branch 'reorganize-gallery' of github.com:GenericMappingTools/p…
willschlitzer Mar 9, 2021
56358b0
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 9, 2021
4b1bb78
Replace underscores with hyphens in file names for gallery examples
willschlitzer Mar 9, 2021
8c70c98
Merge branch 'master' into reorganize-gallery
seisman Mar 9, 2021
b978c7e
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 10, 2021
363b54b
Replace hyphens with underscores
willschlitzer Mar 11, 2021
e2b6007
Reorganize galleries
willschlitzer Mar 11, 2021
b78b9e8
Merge branch 'master' into reorganize-gallery
willschlitzer Mar 11, 2021
f953632
Rename two files using underscores
seisman Mar 11, 2021
e0e507d
Rename inset-tutorial.py to insets.py
seisman Mar 11, 2021
f6622f8
Update references in examples
seisman Mar 11, 2021
e3c8c10
Rename 3d-plots to 3d_plots
seisman Mar 11, 2021
ce706f4
Fix a broken reference to inset.py
seisman Mar 11, 2021
a3c54aa
Merge branch 'master' into reorganize-gallery
seisman Mar 12, 2021
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
15 changes: 9 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# isort: off
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
Expand Down Expand Up @@ -71,10 +71,13 @@
"gallery_dirs": ["gallery", "tutorials", "projections"],
"subsection_order": ExplicitOrder(
[
"../examples/gallery/line",
"../examples/gallery/coast",
"../examples/gallery/plot",
"../examples/gallery/grid",
"../examples/gallery/maps",
"../examples/gallery/lines",
"../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",
Expand All @@ -88,7 +91,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
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/gallery/3d_plots/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
3D Plots
--------
2 changes: 0 additions & 2 deletions examples/gallery/coast/README.txt

This file was deleted.

2 changes: 2 additions & 0 deletions examples/gallery/embellishments/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Plot embellishments
-------------------
File renamed without changes.
2 changes: 0 additions & 2 deletions examples/gallery/grid/README.txt

This file was deleted.

2 changes: 2 additions & 0 deletions examples/gallery/images/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Images, contours, and fields
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
----------------------------
File renamed without changes.
2 changes: 0 additions & 2 deletions examples/gallery/line/README.txt

This file was deleted.

2 changes: 2 additions & 0 deletions examples/gallery/lines/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Lines and vectors
-----------------
Original file line number Diff line number Diff line change
Expand Up @@ -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 </gallery/line/vectors>`)
:doc:`Vector types documentation </gallery/lines/vectors>`)
by passing the corresponding shortcuts to the ``style`` parameter.

"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 </gallery/line/vector-heads-tails>`.
:doc:`Vector attributes documentation </gallery/lines/vector_heads_tails>`.

"""
import numpy as np
Expand Down
2 changes: 2 additions & 0 deletions examples/gallery/maps/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Maps and map elements
---------------------
File renamed without changes.
2 changes: 0 additions & 2 deletions examples/gallery/plot/README.txt

This file was deleted.

2 changes: 2 additions & 0 deletions examples/gallery/seismology/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Seismology and geodesy
----------------------
File renamed without changes.
2 changes: 2 additions & 0 deletions examples/gallery/symbols/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Symbols and markers
-------------------
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/tutorials/lines.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down