https://github.com/mcabbott/runmynotes.jl
iterates Literate.jl
https://github.com/mcabbott/runmynotes.jl
Last synced: 6 months ago
JSON representation
iterates Literate.jl
- Host: GitHub
- URL: https://github.com/mcabbott/runmynotes.jl
- Owner: mcabbott
- License: other
- Created: 2018-12-20T18:08:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-08T16:57:16.000Z (over 6 years ago)
- Last Synced: 2024-10-13T19:28:29.693Z (over 1 year ago)
- Language: Julia
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RunMyNotes.jl
I like to write up notes of how to use my packages in plain `.jl` files,
which the package [Literate.jl](https://github.com/fredrikekre/Literate.jl) can run,
producing `.ipynb` notebooks, with graphs embedded.
This little package automates that slightly. Typing this:
```
folder("~/.julia/dev/MyPackage/notes/")
```
or (roughly) equivalently
```
import MyPackage
package(MyPackage)
```
will run all files in that folder.
Then it will convert the resulting notebooks to `.html`
to make it easier to preview last week's graphs, unless you say `html=false`.
You can also pass `all=false` to update only files that have changed.
By default everything is saved in the same folder,
but to avoid saving for all eternity every day's versions of all figures etc,
I add to `.gitignore` these lines:
```
.DS_Store
*.ipynb
*.html
```
Then I can happily include this in the package's tests, it returns `true` if there are no errors.
In fact if you type `] test RunMyNotes` this will happen for this package itself,
for a simple [note.jl](notes/note.jl). Or else:
```
using RunMyNotes
package(RunMyNotes, "~/Desktop")
```
Michael Abbott, December 2018