Move projection table to Technical References #3356
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/format |
seisman
reviewed
Jul 25, 2024
seisman
reviewed
Jul 25, 2024
doc/techref/index.md
Outdated
| @@ -9,4 +9,5 @@ visit the {gmt-docs}`GMT Technical Reference <reference.html>`. | |||
| :maxdepth: 1 | |||
|
|
|||
| encodings.md | |||
| projections.md | |||
There was a problem hiding this comment.
It should be .rst unless you want to convert it to markdown
Suggested change
| projections.md | |
| projections.rst |
There was a problem hiding this comment.
Changed in b351314.
I would prefer to have a separate PR for rewriting the projection table to markdown.
seisman
reviewed
Jul 25, 2024
seisman
added
documentation
seisman
approved these changes
Jul 25, 2024
seisman
added
the
final review call
Co-authored-by: Dongdong Tian <[email protected]>
seisman
changed the title
yvonnefroehlich
commented
Jul 25, 2024
| @@ -113,7 +113,7 @@ jobs: | |||
| sphinx-autodoc-typehints | |||
| sphinx-copybutton | |||
| sphinx-design | |||
| sphinx-gallery<0.17.0 | |||
| sphinx-gallery | |||
There was a problem hiding this comment.
I am wondering if we should have two PRs:
- one for moving the projection table to fix issue Documentation building fails with sphinx-gallery 0.17.0 #3346
- one for unpinning the sphinx-gallery version to revert PR Temporarily pin sphinx-gallery<0.17.0 #3350
seisman
removed
the
final review call
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Since Sphinx-Gallery 0.17.0, building the Documentation fails (see #3346 (comment)). It seems like the problem is the
pygmt/examples/projections/tablefolder which only contains the README file with the projection table (see #3346 (comment)). To fix this and get rid of thetablefolder, this PR moves the projection table to the "Technical References".Fixes #3346
Previews
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code