Skip to content

Add sphinx-copybutton extension to easily copy codes#838

Merged
seisman merged 4 commits intomasterfrom
sphinx-copybutton
Feb 5, 2021
Merged

Add sphinx-copybutton extension to easily copy codes#838
seisman merged 4 commits intomasterfrom
sphinx-copybutton

Conversation

@seisman
Copy link
Member

@seisman seisman commented Feb 5, 2021

Description of proposed changes

Try it:

Reference: https://sphinx-copybutton.readthedocs.io/en/latest/

Fixes #833

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 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

@seisman seisman added the documentation Improvements or additions to documentation label Feb 5, 2021
@seisman seisman added this to the 0.3.0 milestone Feb 5, 2021
@seisman seisman requested a review from a team February 5, 2021 19:17
@seisman seisman marked this pull request as ready for review February 5, 2021 19:19
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

The copybutton looks a bit small but hopefully people can notice it:

image

@weiji14 weiji14 changed the title Add the sphinx-copybutton extension to easily copy codes Add sphinx-copybutton extension to easily copy codes Feb 5, 2021
Copy link
Member

@liamtoney liamtoney left a comment

Choose a reason for hiding this comment

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

Great addition!

@seisman seisman merged commit ecbc170 into master Feb 5, 2021
@seisman seisman deleted the sphinx-copybutton branch February 5, 2021 20:52
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the sphinx-copybutton extension for easier copying codes

3 participants