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

Improve instructions about setting GMT_LIBRARY_PATH env variable #2136

Merged
merged 4 commits into from
Oct 9, 2022

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 25, 2022

Description of proposed changes

Fixes #1993

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 added the documentation Improvements or additions to documentation label Sep 25, 2022
@seisman seisman added this to the 0.8.0 milestone Sep 25, 2022
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated
respectively.

For Linux/macOS, adding the following line to your shell configuration file
(usually `~/.bashrc` for Bash on Linux and `~/.zshrc` for Zsh on macOS)::
Copy link
Member

Choose a reason for hiding this comment

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

Should we use the tab thing for Linux/macOS/Windows instructions? Similar to what is currently used for conda/mamba?

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 don't think it's necessary.

doc/install.rst Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Oct 8, 2022
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 9, 2022
@seisman seisman merged commit 47fb480 into main Oct 9, 2022
@seisman seisman deleted the set-libpath branch October 9, 2022 02:09
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…ericMappingTools#2136)

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
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.

Improve the "Finding the GMT shared library" section in the installation instructions
2 participants