search

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
758 stars 220 forks source link

Add more targets to doc/makefile help information #914

Closed maxrjones closed 3 years ago

maxrjones commented 3 years ago

Description of the problem

The available targets in the docs Makefile are help, clean, html, api, linkcheck, doctest, and serve. The help target only lists information about the all, html, linkcheck, and doctest targets. One line each could be added to help to describe clean,api, and serve, for example @echo " clean clean up build and generated files".

seisman commented 3 years ago

We may want to remove the linkcheck target, because make linkcheck is so slow (> 5 minutes for me), and we will have a workflow for checking links (#634) (in process, but close to be ready).

weiji14 commented 3 years ago

I never even realized we had a make linkcheck :sweat_smile: But yes, agree that this is a good first issue.

And just wanting to raise the issue of making things cross-platform (read: runs on Windows). Leo suggested using nox at https://github.com/GenericMappingTools/pygmt/pull/679#issuecomment-723147333 and https://github.com/fatiando/maintenance/issues/8, but I'm wondering if our Makefile would just work on Windows if we install make from conda-forge?

seisman commented 3 years ago

@GenericMappingTools/python @GenericMappingTools/python-contributors @GenericMappingTools/python-maintainers

We are close to the v0.3.1 release, and I think we can wrap up this issue. Does anyone want to work on it?

core-man commented 3 years ago

@GenericMappingTools/python @GenericMappingTools/python-contributors @GenericMappingTools/python-maintainers

We are close to the v0.3.1 release, and I think we can wrap up this issue. Does anyone want to work on it?

I am working on it in #1014