Skip to content

Add more targets to doc/makefile help information #914

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

Closed
maxrjones opened this issue Feb 16, 2021 · 4 comments · Fixed by #1014
Closed

Add more targets to doc/makefile help information #914

maxrjones opened this issue Feb 16, 2021 · 4 comments · Fixed by #1014
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@maxrjones
Copy link
Member

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".

@maxrjones maxrjones added good first issue Good for newcomers documentation Improvements or additions to documentation labels Feb 16, 2021
@seisman
Copy link
Member

seisman commented Feb 16, 2021

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).

@seisman seisman added this to the 0.3.1 milestone Feb 16, 2021
@weiji14
Copy link
Member

weiji14 commented Feb 16, 2021

I never even realized we had a make linkcheck 😅 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 #679 (comment) and fatiando/maintenance#8, but I'm wondering if our Makefile would just work on Windows if we install make from conda-forge?

@seisman
Copy link
Member

seisman commented Mar 7, 2021

@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
Copy link
Member

core-man commented Mar 7, 2021

@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

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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants