DOC: List all dependencies in the instalation guides - #4807
Conversation
seisman
added
documentation
| We recommend following the instructions further on to install GMT 6. | ||
| We recommend following the instructions further on to install GMT. | ||
|
|
||
| ## Dependencies |
There was a problem hiding this comment.
Maybe move the "Dpendencies" section to the top, similar as in the README? To let users know which packages will be installed together with PyGMT.
There was a problem hiding this comment.
I prefer to keep the "Quickstart" section as the first section, so that users can install PyGMT without knowing any details.
README is mainly for describing the project, so I think in that file, it makes more sense to have "Dependencies" before "QuickStart".
There was a problem hiding this comment.
Pull request overview
Updates the installation guide to include an explicit “Dependencies” section (mirroring the README) so users can see required vs optional Python dependencies alongside GMT.
Changes:
- Reformats parts of
doc/install.mdfor improved readability/line wrapping. - Reworks the “Dependencies” section into Required/Optional dependency lists and links to minimum version requirements.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Similar to the "Dependencies" section in https://github.com/GenericMappingTools/pygmt#dependencies.
Preview: https://pygmt-dev--4807.org.readthedocs.build/en/4807/install.html#dependencies