Move projection table to Technical References (#3356)

GenericMappingTools · Jul 26, 2024 · ff246c6 · ff246c6
1 parent ecaab8f
commit ff246c6
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -113,7 +113,7 @@ jobs:
             sphinx-autodoc-typehints
             sphinx-copybutton
             sphinx-design
-            sphinx-gallery<0.17.0
+            sphinx-gallery
             sphinx_rtd_theme
 
       # Download cached remote files (artifacts) from GitHub

diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -28,5 +28,5 @@ dependencies:
     - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
-    - sphinx-gallery<0.17.0
+    - sphinx-gallery
     - sphinx_rtd_theme
diff --git a/doc/techref/index.md b/doc/techref/index.md
@@ -8,5 +8,6 @@ visit the {gmt-docs}`GMT Technical Reference <reference.html>`.
 ```{toctree}
 :maxdepth: 1
 
+projections.rst
 encodings.md
 ```
diff --git a/examples/projections/table/README.txt → doc/techref/projections.rst b/examples/projections/table/README.txt → doc/techref/projections.rst
@@ -1,5 +1,5 @@
-Projection Table
-----------------
+GMT Map Projections
+-------------------
 
 The table below shows the projection codes for the 31 GMT projections:
 

diff --git a/environment.yml b/environment.yml
@@ -40,7 +40,7 @@ dependencies:
     - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
-    - sphinx-gallery<0.17.0
+    - sphinx-gallery
     - sphinx_rtd_theme
     # Dev dependencies (type hints)
     - mypy

diff --git a/examples/projections/README.txt b/examples/projections/README.txt
@@ -1,10 +1,11 @@
 Projections
 ===========
 
-PyGMT supports many map projections. Use the ``projection`` parameter to specify which
-one you want to use in all plotting methods. The projection is specified by a one-letter
-code along with (sometimes optional) reference longitude and latitude and the
-width of the map (for example, **A**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*). The map
-height is determined based on the region and projection.
+PyGMT supports many map projections; see :doc:`/techref/projections` for an overview.
+Use the ``projection`` parameter to specify which one you want to use in all plotting
+methods. The projection is specified by a one-letter code along with (sometimes optional)
+reference longitude and latitude and the width of the map (for example,
+**A**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*). The map height is determined based on the
+region and projection.
 
 These are all the available projections: