DOC: fix CL tutorial to give same output from saved file and example#12394
Conversation
| ############################################# | ||
| # A better way to get around this awkwardness is to simply | ||
| # use a legend for the figure: | ||
| # use the legend method provided by the figure class: |
|
Yes this works now as expected. Maybe the text should clearly state here that in order to see the effect one would need to compare the shown (add |
|
Can we include images in the tutorials? I guess I could just include the png. WRT item 3 I was t sure it was necessary but happy to do it if you feel it helps |
|
I think some of the confusion comes from looking at the produced images, so if at least the code has the savefig command in it, it would point more towards where to look for the feature. I think you can use rst inside the examples, so |
|
The manually added figures are a bit... HUGE.
But appart this looks good. With both figures shown like this I think the whole section becomes really clear. |
jklymak
force-pushed
the
doc-fix-cl-tutorial
branch
from
fc9967d to
e84c56c
Compare
|
Seems better now, maybe a little small, but I think thats fine:
|
|
What's the reason for the difference? Shouldn't it save with the same dpi as it shows? Ah, you changed the width... Why not produce the figure with |
|
I had to hard-set the width to 300 px in the |
|
|
ImportanceOfBeingErnest
left a comment
ImportanceOfBeingErnest
left a comment
There was a problem hiding this comment.
This makes the Legend section of the constrained layout guide much clearer and it's well suited to prevent misunderstandings as in #12377.
| # The saved file looks like: | ||
| # | ||
| # .. image:: /_static/constrained_layout/CL02.png | ||
| # :align: center |
There was a problem hiding this comment.
The center alignment seems to be ignored for some reason by the css. I would not consider this crucial at this point. One can revisit the cause of this at a different stage.
There was a problem hiding this comment.
:-( Oh well I tried. As I'm sure you can tell screwing around w/ rst embedded in python comments isn't my favourite pastime.
There was a problem hiding this comment.
There is nothing wrong with the rst command itself. It's either sphinx having changed something in their newest version or us screwing up the CSS.
I think adding something like
img.align-center {
display: block;
margin-left: auto;
margin-right: auto;}
in the css file will center the image correctly.
It's something to keep in mind, but somehow unrelated to this PR anyways.
jklymak
force-pushed
the
doc-fix-cl-tutorial
branch
from
b38f71a to
d71b44b
Compare
…t from saved file and example
…t from saved file and example
|
Thanks for the help @ImportanceOfBeingErnest |
…394-on-v3.0.x Backport PR #12394 on branch v3.0.x (DOC: fix CL tutorial to give same output from saved file and example)
…394-on-v3.0.0-doc Backport PR #12394 on branch v3.0.0-doc (DOC: fix CL tutorial to give same output from saved file and example)
|
It seems one drawback of this is that now every time you build the docs it'll create two png images in the tutorials folder, which will then end up in any commit (if one doesn't pay attention). |
4 participants
PR Summary
Closes #12391.
When CI passes I'll post the result here for review....
As it'll post in the docs
As it looks in saved file
PR Checklist