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

Revise pygmt development installation instructions #865

Merged
merged 7 commits into from
Feb 12, 2021

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Feb 12, 2021

Description of proposed changes

Ensure that users can install the development version of PyGMT without getting a LookupError. Also update instructions on installing pygmt from conda/pip. Some changes include:

  • Added a quickstart section so people can get up and running quicker!
  • Split some things up into subsections to be clearer
  • Point out what are recommended or optional steps

Live preview is at https://pygmt-git-fix-pip-install-dev.gmt.vercel.app/install.html

Fixes #856

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

Update instructions on installing pygmt from pip.
Split things up into subsections to be clearer, and
point out what are recommended or optional steps.
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Feb 12, 2021
@weiji14 weiji14 added this to the 0.3.0 milestone Feb 12, 2021
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
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.

@weiji14 weiji14 marked this pull request as ready for review February 12, 2021 08:28
@weiji14 weiji14 merged commit d3e09c7 into master Feb 12, 2021
@weiji14 weiji14 deleted the fix-pip-install-dev branch February 12, 2021 09:18
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…ls#865)

Ensure that users can install the development version of PyGMT
without getting a `LookupError`. Also update instructions on
installing pygmt from conda/pip. Some changes include:

- Added a quickstart section so people can get up and running quicker!
- Split some things up into subsections to be clearer
- Point out what are recommended or optional steps

* Set fallback scm version to 0+unknown

Co-authored-by: Dongdong Tian <[email protected]>
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.

Fail to install the dev version following the install instructions
2 participants