Add inline example for grdcut

[willschlitzer]

This PR adds an inline code example to the docstring for grdcut.

Addresses #1686

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.

Slash Commands

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

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[maxrjones]

The example looks nice!

Do you want to figure out the CI separation mentioned here as part of this RFC?

[willschlitzer]

The example looks nice!

Do you want to figure out the CI separation mentioned here as part of this RFC?

@meghanrjones I decided to use # doctest: +SKIP; I think the better long term solution is to edit the makefile, but I don't want to go outside the scope of this PR.

[maxrjones]

The example looks nice!
Do you want to figure out the CI separation mentioned here as part of this RFC?

@meghanrjones I decided to use # doctest: +SKIP; I think the better long term solution is to edit the makefile, but I don't want to go outside the scope of this PR.

It's nice that the doctest comments are not included in the rendered html docs: https://pygmt-5z64fvi6h-gmt.vercel.app/api/generated/pygmt.grdcut.html#pygmt.grdcut.

[maxrjones]

Looks good to me!

[weiji14]

The example looks nice!
Do you want to figure out the CI separation mentioned here as part of this RFC?

@meghanrjones I decided to use # doctest: +SKIP; I think the better long term solution is to edit the makefile, but I don't want to go outside the scope of this PR.

It's nice that the doctest comments are not included in the rendered html docs: https://pygmt-5z64fvi6h-gmt.vercel.app/api/generated/pygmt.grdcut.html#pygmt.grdcut.

Wow, very handy that they hide the # doctest: +SKIP comment! So much for overthinking. Let's hope that Sphinx keeps this as a 'feature' rather than a 'bug' 😆

[seisman]

Is there any way to skip the entire code block using a single directive?

[willschlitzer]

Is there any way to skip the entire code block using a single directive?

The example I found online involves wrapping the example in a function, and then calling that function but then adding doctest: +SKIP. I think that would complicate the example code if we tried that.