Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jul 25, 2024

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/table folder which only contains the README file with the projection table (see #3346 (comment)). To fix this and get rid of the table folder, this PR moves the projection table to the "Technical References".

Fixes #3346

Previews

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich
Copy link
Member Author

/format

:maxdepth: 1
encodings.md
projections.md
Copy link
Member

Choose a reason for hiding this comment

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

It should be .rst unless you want to convert it to markdown

Suggested change
projections.md
projections.rst

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed in b351314.

I would prefer to have a separate PR for rewriting the projection table to markdown.

@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Jul 25, 2024
@seisman seisman added this to the 0.13.0 milestone Jul 25, 2024
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

looks good to me except one comment

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jul 25, 2024
@seisman seisman changed the title POC / DRAFT / WIP: Move projection table to Technical References Move projection table to Technical References Jul 25, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Jul 25, 2024
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

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jul 26, 2024
@seisman seisman merged commit ff246c6 into main Jul 26, 2024
@seisman seisman deleted the move-proj-table-to-techref branch July 26, 2024 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation building fails with sphinx-gallery 0.17.0

3 participants