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

Set the documentation build to use viridis as the default colormap #2889

Merged
merged 1 commit into from
Oct 31, 2017

Conversation

pelson
Copy link
Member

@pelson pelson commented Oct 28, 2017

This is necessary because we still have mpl 1, not 2.

In addition, I was finding that the image scroller on the homepage was showing a black background for unusually shaped images. I fixed this by setting the background to white - it would be awesome to have a thorough refresh of the docs' styling, but I didn't get around to doing that yet.

@pelson pelson added this to the v2.0.0 milestone Oct 28, 2017
@pelson pelson force-pushed the viridis_for_docs branch 2 times, most recently from 68ee4b0 to d88dd44 Compare October 30, 2017 15:51
…ather than Jet as we are using matplotlib 1 still).
Copy link
Member

@DPeterK DPeterK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pelson I've no problem with the changes... I just don't understand why a couple of them are needed 🤓

@@ -131,8 +131,10 @@ script:
# affect any downstream functionality but causes the build to fail
# spuriously. The echo-backtick workaround gets around this error,
# which should be investigated further in the future.
- if [[ $TEST_TARGET == 'doctest' ]]; then
- >
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this add that we didn't have before?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tells yaml to go into multi-line mode, and prevents travis from going crazy from the newly added pipe line. Without it, travis can't even read the config file.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously, everything was concatenated into one line, so theoretically, you could also drop the semicolons on every line here as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know. I'm tempted to do this once a few of the changes to the travis.yml have been merged.

@@ -29,7 +29,7 @@
// Only use first 5 images
for (var i = 0; i < 5; i++) {
var img = images[i];
$ss.append('<a href="'+img[2]+'"><img src="'+img[1]+'" class="slideshowImage"/></a>');
$ss.append('<a href="'+img[2]+'" style="background-color: white;" ><img src="'+img[1]+'" class="slideshowImage"/></a>');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I understand what this is doing I don't understand why it's needed – I haven't seen a problem with the slideshow that should require such a CSS change...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bad_background

I'm on Chrome for OSX 61.0.3163.100.

Visiting https://scitools-docs.github.io/iris/master/index.html.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah – note the difference to http://scitools.org.uk/iris/docs/latest/index.html (where the above black bars never appear, so I'll not add an image!).

@pelson
Copy link
Member Author

pelson commented Oct 31, 2017

Just to be clear to anybody doing any investigation on when the colormap changed - viridis isn't necessarily the best colormap, but in all circumstances, it is significantly better than jet as a default. Happy for individual examples to set their own colormaps on a per-example basis.

@DPeterK DPeterK merged commit a468509 into SciTools:master Oct 31, 2017
@pelson pelson deleted the viridis_for_docs branch November 1, 2017 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants