Skip to content
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

Use Literate.jl for examples? #358

Closed
ali-ramadhan opened this issue Aug 18, 2019 · 1 comment
Closed

Use Literate.jl for examples? #358

ali-ramadhan opened this issue Aug 18, 2019 · 1 comment
Labels
documentation 📜 The sacred scrolls
Milestone

Comments

@ali-ramadhan
Copy link
Member

Looks like we can use the literate programming paradigm and Literate.jl to write well-documented examples that also compile straight to documentation as a tutorial. We can even include plots that are generated and included in the tutorial.

https://github.com/fredrikekre/Literate.jl

@ali-ramadhan ali-ramadhan added the documentation 📜 The sacred scrolls label Aug 18, 2019
@ali-ramadhan ali-ramadhan added this to the JOSS milestone Aug 18, 2019
@ali-ramadhan
Copy link
Member Author

Closing for now as it's not necessary for JOSS. I originally opened this issue to remind myself about this package.

Might revisit once we have examples and are trying to write tutorials.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 The sacred scrolls
Projects
None yet
Development

No branches or pull requests

1 participant