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.

Sign up for GitHub

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

Move projection table to Technical References #3356

Merged
merged 9 commits into from
Jul 26, 2024
Merged

Move projection table to Technical References #3356

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
50a9bc2
Move projection table to Technical References
yvonnefroehlich Jul 25, 2024
43cdb4c
Unpin sphinx-gallery
yvonnefroehlich Jul 25, 2024
0c16126
Fix permission
yvonnefroehlich Jul 25, 2024
0f1c43e
Rename to 'projections'
yvonnefroehlich Jul 25, 2024
5912b89
Fix line length
yvonnefroehlich Jul 25, 2024
32e8f87
Improve title
yvonnefroehlich Jul 25, 2024
c421991
Rename to 'projections' in toctree
yvonnefroehlich Jul 25, 2024
b351314
Fix md to rst
yvonnefroehlich Jul 25, 2024
d72267e
Sort items by importance in Technical References
yvonnefroehlich Jul 25, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/ci_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
sphinx-autodoc-typehints
sphinx-copybutton
sphinx-design
sphinx-gallery<0.17.0
sphinx-gallery
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering if we should have two PRs:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think one PR is OK

sphinx_rtd_theme

# Download cached remote files (artifacts) from GitHub
Expand Down
2 changes: 1 addition & 1 deletion ci/requirements/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ dependencies:
- sphinx-autodoc-typehints
- sphinx-copybutton
- sphinx-design
- sphinx-gallery<0.17.0
- sphinx-gallery
- sphinx_rtd_theme
1 change: 1 addition & 0 deletions doc/techref/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ visit the {gmt-docs}`GMT Technical Reference <reference.html>`.
:maxdepth: 1

encodings.md
projection_table.md
seisman marked this conversation as resolved.
Show resolved Hide resolved
```
0 examples/projections/table/README.txt → doc/techref/projection_table.rst
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion examples/projections/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Projections
===========

PyGMT supports many map projections. Use the ``projection`` parameter to specify which
PyGMT supports many map projections (:doc:`/techref/projection_table`).
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
Expand Down