Skip to content
This repository has been archived by the owner on Jan 3, 2018. It is now read-only.

Tracking images produced from IPython Notebooks #451

Closed
gvwilson opened this issue Apr 21, 2014 · 2 comments
Closed

Tracking images produced from IPython Notebooks #451

gvwilson opened this issue Apr 21, 2014 · 2 comments

Comments

@gvwilson
Copy link
Contributor

  1. The websites for Software Carpentry bootcamps are hosted on GitHub, which generates them automatically by running a tool called Jekyll whenever content is committed to a repository's gh-pages branch.
  2. Jekyll knows how to convert compile Markdown and HTML, but doesn't understand IPython Notebooks, so if people have notebooks in their bootcamp repository, they have to run nbconvert on their own machine and add the generated .md file to the repository. (Yes, we could do something clever with post-commit hooks and continuous integration systems, but this seems simpler for our users.)
  3. When nbconvert runs, it creates image files on disk for the plots and other code-generated visuals in the notebook. These image files have auto-generated names like 01-numpy_76_0.png, and the Markdown/HTML generated by nbconvert links to them.
  4. We can easily add those images to the version control repository as well - but if we move cells around in the notebook, nbconvert will give them different names the next time it runs. We can add those images to version control too, but what do we do about cleaning out the old ones? One suggestion is to 'git rm' all the generated images before re-running nbconvert and trust git to detect the new image and infer that we meant to 'git mv', but that feels dangerous.

See #428 for discussion, or this issue on the IPython developers' list.

@wking
Copy link
Contributor

wking commented Apr 21, 2014

Topics related to the larger issue of versioning generated files:

@rgaiacs
Copy link

rgaiacs commented Sep 30, 2014

I'm closing this for now and will reopen it after we close #759.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants