JuliaAcademy / JuliaTutorials

Learn Julia via interactive tutorials!
https://julialang.org/learning/
MIT License
1.26k stars 657 forks source link

Make git reviews easier: Set up auto-exporting scripts from notebook files on save #57

Closed NHDaly closed 4 years ago

NHDaly commented 4 years ago

Set up jupyter configuration to automatically export a script file whenever a Jupyter Notebook file (.ipynb) in the repo is saved. This makes diffing changes in git significantly easier.

The files are exported to a top-level directory called .nbexports, which mirrors the filepaths of the real files. (Note, when scripts are renamed / deleted, it will require manual cleanup from the .nbexports directory)


Add CONTRIBUTING.md to explain .nbexports and our jupyter config. Explains that for contributing to this repo, you should start Jupyter from the top-level of this repo direcotory in order to make sure jupyter picks up our configuration files.


Manually run the exporter for all our files to seed the repo so that future PRs are more easily reviewed! :)


This PR will be easier to review if you first only look at the changes before running the generation: https://github.com/JuliaComputing/JuliaBoxTutorials/pull/57/files/2a2f2387fe7a492d0e935991f0f461f51e28ca4d

Then you can look at the final commit by itself: 9dc69c4