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 long-form documentation, including Jupyter notebooks #45

Closed
epatters opened this issue Sep 24, 2019 · 0 comments
Closed
Labels

Comments

@epatters
Copy link
Member

epatters commented Sep 24, 2019

We now have several Jupyter notebooks providing long-form, tutorial-style documentation. They do not version control cleanly, and it is easy to forget to update them, because executing them is not part of the build process.

I think Literate.jl, which is reminiscent of R Markdown, could provide a good solution to both problems. We can generate and execute Juypter notebooks during the build process, and also generate Markdown files suitable for Documenter.jl.

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

No branches or pull requests

1 participant