-
Notifications
You must be signed in to change notification settings - Fork 121
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.
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
Switch examples to use Literate.jl and update to 1.0 #339
Conversation
ef43c39
to
a062c35
Compare
a062c35
to
e4ba9a2
Compare
Some reasoning for decisions I made in this PR
Followup things to do
PRs welcome :) |
Travis passes; I think the coveralls decrease is spurious since I haven't changed anything in /src or /test. I'll go ahead and merge this-- it would be nice to preview to make sure everything works (it does locally at least), but I'll just fix it up after if there are problems. edit: I decided to rebase first, so I'll just merge tomorrow if CI looks good still. |
Remove old files Rename files Add missing file Add docs build for notebooks Update README Write my own build.jl Make build.jl less verbose Fix path, add `Literate` to project add information logging Fix relative path Fix relative path to notebooks
Co-Authored-By: Paul Söderlind <paulsoderlind@users.noreply.github.com>
More small fixes Tweak plots Fix for 1.0 and clean up Try to fix Travis Support 1.0 Another attempt to fix plotting on Travis clean up
dc724da
to
302c678
Compare
Nice LOC net deletion here: |
Closes #335, closes #268, closes #201 (which I'm not sure is relevant now anyway, but with the examples updated it surely can be closed). Supersedes #261.
I converted the examples to use Literate.jl. The notebook files can be generated by
examples/build.jl
, which is automatically done indocs/make.jl
so that we can serve the built notebooks in the docs.There may be a better way to do the docs building; currently, Documenter emits warnings for the links to the notebooks(edit: just had some bad paths).I also would like to render an HTML version so the user doesn't need to open the Jupyter notebooks necessarily. That requires the notebooks to run though! Hence I've updated all the notebooks to 1.0, and standardized plotting on Plots.jl as suggested in #338. I use a mix of ECOS and SCS since ECOS is better suited for some problems. The
docs/make.jl
file now uses Literate to build markdown versions of all the examples which it includes in the docs.To do:
examples/build.jl
script so it's easy to work with one example at a time (if you're updating or adding a new one).Code for converting examples:
This was run in the
examples
directory.which was modified from https://github.com/JuliaComputing/JuliaAcademyMaterials/blob/master/unliterate.jl.