Skip to content

DOC: CL tutorial now saves png each time... #12677

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
jklymak opened this issue Oct 30, 2018 · 2 comments · Fixed by #17947
Closed

DOC: CL tutorial now saves png each time... #12677

jklymak opened this issue Oct 30, 2018 · 2 comments · Fixed by #17947
Assignees
@jklymak
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Milestone
v3.3-doc

Comments

@jklymak
Copy link
Member

jklymak commented Oct 30, 2018

Originally posted by @ImportanceOfBeingErnest in #12394 (comment)

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).
@jklymak jklymak added this to the v3.0.0-doc milestone Oct 30, 2018
@jklymak jklymak self-assigned this Oct 30, 2018
@jklymak
Copy link
Member Author

jklymak commented Oct 30, 2018

... or if someone else wants to put the savefig statements into an if-False loop, that'd be fine.

@jklymak jklymak added Documentation Good first issue Open a pull request against these issues if there are no active ones! labels Oct 30, 2018
@ImportanceOfBeingErnest
Copy link
Member

I think my preferred solution would be either

  • to turn the respective code blocks into rst blocks, such that they are not executed.
  • or to let the code execute, and link to the generated files, instead of those in _static (those can then be removed, such that there is no increase in doc size)

@QuLogic QuLogic modified the milestones: v3.0.0-doc, v3.0.2-doc Nov 27, 2018
@tacaswell tacaswell modified the milestones: v3.0-doc, v3.1-doc Jul 3, 2019
@tacaswell tacaswell modified the milestones: v3.1-doc, 3.2-doc Mar 15, 2020
@jklymak jklymak mentioned this issue Jul 17, 2020
Merged
6 tasks
@QuLogic QuLogic modified the milestones: 3.2-doc, v3.3-doc Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jklymak jklymak

Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
v3.3-doc
Development

Successfully merging a pull request may close this issue.

DOC: don't make CL tutorial save new file all the time jklymak/matplotlib
4 participants
@tacaswell @QuLogic @jklymak @ImportanceOfBeingErnest