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

Include PS images for docs in releases #6533

Merged
merged 1 commit into from
Apr 11, 2022
Merged

Include PS images for docs in releases #6533

merged 1 commit into from
Apr 11, 2022

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented Apr 7, 2022

Description of proposed changes

In past GMT releases, users could build the documentation from the source tarballs because the .PS files were included in the doc/examples and doc/scripts directories. This PR maintains that option for future releases by copying the doc/examples/images and doc/scripts/images directories to the release directory.

Supersedes #6473, which tried to solve the problem by generating the images directly. I think this PR is better because it is simpler and therefore easier to maintain. While #6473 worked for me locally, it failed to work in the CI due to issues finding dcw and the supplement modules.

Whereas #6473 would have provided an option for building the docs either from a git clone or the releases without DVC, this PR only applies to the releases. To build the docs from a git clone, users will still need to install dvc and run dvc pull first.

Relates to #5724, #6356

@maxrjones maxrjones added the maintenance Boring but important stuff for the core devs label Apr 7, 2022
@maxrjones maxrjones requested a review from a team April 7, 2022 22:26
@PaulWessel
Copy link
Member

Seems to work. I notice the tar ball has both PS and PNG files, e.g.

./gmt-6.4.0/doc_release/html/_images/GMT_seamount_flux.png
./gmt-6.4.0/doc/scripts/images/GMT_seamount_flux.ps

I guess this is intentional since the png supports to html tree while the PS file is there for building it.

@Esteban82
Copy link
Member

This can be merge, right?

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 this pull request may close these issues.

3 participants