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.

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

Add instructions to install PyGMT using mamba #1967

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Add instructions to install PyGMT using mamba #1967

merged 2 commits into from
Jun 24, 2022

Conversation

seisman
Copy link
Member

@seisman seisman commented Jun 17, 2022

Description of proposed changes

Use sphinx-design's tab-set directive to show conda and mamba usage.

Fixes #1663.

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

@seisman seisman marked this pull request as ready for review June 23, 2022 01:59
@seisman seisman added this to the 0.7.0 milestone Jun 23, 2022
@seisman seisman added the documentation Improvements or additions to documentation label Jun 23, 2022
@seisman
Copy link
Member Author

seisman commented Jun 23, 2022

I'm not sure if this is a good way to document how to install PyGMT using mamba. Please let me know what you think.

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.

I'm not sure if this is a good way to document how to install PyGMT using mamba. Please let me know what you think.

Looks great actually! Much cleaner than repeating in two lines.

Note that the sync directive only works with javascript I think, but even without javascript, the user can still switch between the conda and mamba tabs. The tab switching also works with a keyboard's left and right arrows, so seems ok accessibility-wise.

@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Jun 23, 2022
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 24, 2022
@seisman seisman merged commit 6b94baf into main Jun 24, 2022
@seisman seisman deleted the mamba-install branch June 24, 2022 00:21
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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 installing with mamba to docs?
3 participants