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 tutorial section in the documentation sidebar #1603

Merged
merged 13 commits into from
Nov 14, 2021
Merged
3 changes: 3 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@
"../examples/projections/misc",
"../examples/projections/nongeo",
"../examples/projections/table",
"../examples/tutorials/beginner",
"../examples/tutorials/intermediate",
"../examples/tutorials/advanced",
]
),
# Patter to search for example files
Expand Down
27 changes: 4 additions & 23 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,17 @@

overview.rst
install.rst
tutorials/first_figure.rst

.. toctree::
:maxdepth: 2
:hidden:
:caption: Examples

gallery/index.rst
external_resources.md
tutorials/beginner/first_figure.rst

.. toctree::
:maxdepth: 2
:hidden:
:caption: User Guide

tutorials/frames.rst
gallery/index.rst
projections/index.rst
tutorials/coastlines.rst
tutorials/regions.rst
tutorials/plot.rst
tutorials/lines.rst
tutorials/vectors.rst
tutorials/date_time_charts.rst
tutorials/text.rst
tutorials/contour_map.rst
tutorials/earth_relief.rst
tutorials/3d_perspective_image.rst
tutorials/insets.rst
tutorials/subplots.rst
tutorials/configuration.rst
tutorials/index.rst
external_resources.md

.. toctree::
:maxdepth: 2
Expand Down
4 changes: 4 additions & 0 deletions examples/tutorials/README.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
.. _tutorials:

Tutorials
=========

These tutorials teach how to complete various tasks using PyGMT.
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions examples/tutorials/advanced/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Advanced Tutorials
------------------
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@
# Starting off with ``WS``, adding this string means that only
# Western/Left (**W**) and Southern/Bottom (**S**) borders of
# the plot will be shown. For more information on this, please
# refer to :doc:`frame instructions </tutorials/frames>`.
# refer to :doc:`frame instructions </tutorials/beginner/frames>`.
#
# The other important item in the ``frame`` list is
# ``"sxa1Of1D"``. This string modifies the secondary
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions examples/tutorials/beginner/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Beginner Tutorials
------------------
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions examples/tutorials/intermediate/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Intermediate Tutorials
----------------------
File renamed without changes.
4 changes: 2 additions & 2 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"R": r"""
region : str or list
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/regions>` of interest.""",
Specify the :doc:`region </tutorials/beginner/regions>` of interest.""",
"J": r"""
projection : str
*projcode*\[*projparams*/]\ *width*.
Expand All @@ -34,7 +34,7 @@
"B": r"""
frame : bool or str or list
Set map boundary
:doc:`frame and axes attributes </tutorials/frames>`. """,
:doc:`frame and axes attributes </tutorials/beginner/frames>`. """,
"U": """\
timestamp : bool or str
Draw GMT time stamp logo on plot.""",
Expand Down
8 changes: 4 additions & 4 deletions pygmt/src/grdview.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ def grdview(self, grid, **kwargs):
DataArray.
region : str or list
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/regions>` of interest. When used
with ``perspective``, optionally append */zmin/zmax* to indicate the
range to use for the 3-D axes [Default is the region in the input
grid].
Specify the :doc:`region </tutorials/beginner/regions>` of interest.
When used with ``perspective``, optionally append */zmin/zmax* to
indicate the range to use for the 3-D axes [Default is the region in
the input grid].
{J}
zscale/zsize : float or str
Set z-axis scaling or z-axis size.
Expand Down