Skip to content

Update tutorials to build faster #871

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

Merged
merged 11 commits into from
Feb 14, 2021
Merged

Update tutorials to build faster #871

merged 11 commits into from
Feb 14, 2021

Conversation

willschlitzer
Copy link
Contributor

Inadvertent creation of new branch due to changing remote git repository. This is the updated version of #868, including @seisman's comments to remove figures.

Fixes #825

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

@seisman
Copy link
Member

seisman commented Feb 12, 2021

We may speed up the 3d perspective tutorial by using a lower-resolution earth relief grid if #873 can be merged.

@seisman
Copy link
Member

seisman commented Feb 13, 2021

@willschlitzer #873 is already merged. You may try to use low-resolution grids and see if the build time can be reduced.

In the Cache Data workflow, only 01d, 30m, 10m and 05m resolution earth relief grids are cached in the CI jobs. So you may try 10m grid.

@weiji14 weiji14 added the maintenance Boring but important stuff for the core devs label Feb 14, 2021
@seisman seisman added this to the 0.3.0 milestone Feb 14, 2021
@seisman seisman changed the title Change tutorials to build faster Update tutorials to build faster Feb 14, 2021
@seisman seisman added the skip-changelog Skip adding Pull Request to changelog label Feb 14, 2021
@seisman seisman merged commit bc84891 into master Feb 14, 2021
@seisman seisman deleted the speedier-tutorials branch February 14, 2021 19:09
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Use a lower-resolution earth relief grid to reduce the building time

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
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve some tutorials to speed up the Continuous Documentation
3 participants