Skip to content

DOC: replace anatomy static by new example #21928

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

DOC: replace anatomy static by new example #21928

wants to merge 1 commit into from

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Dec 11, 2021 •
edited by timhoffm
Loading

PR Summary

The anatomy of figure example was changed in #21753, but I forgot to update the static version of this for including in other tutorials.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@jklymak jklymak added the Documentation: website layout/behavior/styling changes label Dec 11, 2021
@timhoffm
Copy link
Member

Just noticed the think grey outllne (actually already introduced in #21753). I'm not sure I like that. It's very bulky and a quite uncommon style for our figures.

@jklymak
Copy link
Member Author

jklymak commented Dec 13, 2021

The goal was to differentiate from the rest of the webpage (which is also white). We could color the whole thing but then it's a lot harder to make the little circles look good with their nice occurring effect.

@QuLogic
Copy link
Member

QuLogic commented Dec 14, 2021

I'd rather we link to the generated file rather than another new static image.

@jklymak jklymak force-pushed the doc-replace-anatomy branch from d5692f2 to 7dc6b3b Compare December 16, 2021 09:16
@jklymak
Copy link
Member Author

jklymak commented Dec 16, 2021

Sure, replaced by a link. That way when the example gets updated, this image will also.

@QuLogic
Copy link
Member

QuLogic commented Dec 16, 2021

Unfortunately, it looks like you can't link the 2x image because some builds need to run without them. Maybe we can expand image-sg to allow this, but we'll have to do the 1x image for now.

@jklymak
Copy link
Member Author

jklymak commented Dec 16, 2021

Or have a static.

@jklymak jklymak force-pushed the doc-replace-anatomy branch from 7dc6b3b to dfda45c Compare January 5, 2022 08:47
@jklymak
Copy link
Member Author

jklymak commented Jan 5, 2022

Changed back to hi-res static since the hi-res is not always generated by sphinx-gallery.

timhoffm
timhoffm previously approved these changes Jan 11, 2022
View reviewed changes
@timhoffm timhoffm added this to the v3.5-doc milestone Jan 11, 2022
timhoffm
timhoffm reviewed Jan 11, 2022
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Oh, CircleCI is not happy:

/home/circleci/project/doc/tutorials/introductory/quick_start.rst:96: WARNING: image file not readable: _images/sphx_glr_anatomy_001_2_0x.png

@timhoffm timhoffm dismissed their stale review January 11, 2022 00:16

CI failure

@jklymak jklymak force-pushed the doc-replace-anatomy branch from dfda45c to f3153e7 Compare January 11, 2022 08:09
@jklymak jklymak force-pushed the doc-replace-anatomy branch from f3153e7 to 0b19ed6 Compare January 11, 2022 08:44
timhoffm
timhoffm requested changes Jan 11, 2022
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

This is correct now. I'll temporarily block because I have some idea concerning the figure border that I want to try out. Will get back within 1-2 days.

@timhoffm
Copy link
Member

I've done some formatting improvements in #22206. That should be checked and possibly included before adding a new static image.

@jklymak
Copy link
Member Author

jklymak commented Jan 12, 2022

Lets close and just put the static image in #22206. That saves me having to sync this up with whatever happens there.

@jklymak jklymak closed this Jan 12, 2022
@jklymak jklymak deleted the doc-replace-anatomy branch January 12, 2022 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm requested changes

Assignees
No one assigned
Labels
Documentation: website layout/behavior/styling changes
Projects
None yet
Milestone
v3.5-doc
Development

Successfully merging this pull request may close these issues.
3 participants
@jklymak @timhoffm @QuLogic