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

Add CMake target to generate images for the docs #6356

Closed
maxrjones opened this issue Feb 19, 2022 · 2 comments
Closed

Add CMake target to generate images for the docs #6356

maxrjones opened this issue Feb 19, 2022 · 2 comments
Assignees
Labels
maintenance Boring but important stuff for the core devs

Comments

@maxrjones
Copy link
Member

Description of the desired feature

As a follow-up to #6267, we should add a CMake target to generate the images required for building the documentation, so that those without dvc can still build the documentation.

Are you willing to help implement and maintain this feature? Yes

@maxrjones maxrjones added the maintenance Boring but important stuff for the core devs label Feb 19, 2022
@maxrjones maxrjones self-assigned this Feb 19, 2022
@maxrjones
Copy link
Member Author

I'm running into a problem with example 51 because the script cannot be run without downloading a ~630 MB file. Workarounds include:

  1. modify the script to generate an image without needing that file
  2. use a GitHub hosted image similar to example 53
  3. just require dvc for building the docs and abandon the effort for an alternate option

The downside to the GitHub hosted images is that they are not available in bundled or offline documentation (#6032). But I still prefer option 2 because the example is useful and providing an alternative to dvc is important for allowing people to build the docs from GMT distributions. Any thoughts @GenericMappingTools/gmt-maintainers?

@maxrjones
Copy link
Member Author

Superseded by #6533

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant