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 to incorporate examples into documentation via CI #7

Open
MikaelSlevinsky opened this issue Sep 7, 2020 · 1 comment

Comments

@MikaelSlevinsky
Copy link
Member

I was inspired by https://github.com/FourierFlows/FourierFlows.jl, in particular the example they have (https://github.com/FourierFlows/FourierFlows.jl/blob/master/examples/OneDShallowWaterGeostrophicAdjustment.jl) that gets run as part of the documentation stage in GitHub Actions in every commit. The very nice result is https://fourierflows.github.io/FourierFlowsDocumentation/dev/generated/OneDShallowWaterGeostrophicAdjustment/.

Did the same thing with the FastTransforms examples (since the docs are quite sparse), and I'm pretty pleased. The FourierFlows.jl scripts show that docs can be hosted in a separated repository, so probably it's possible for the examples here to be added to the ApproxFun.jl documentation website. Or alternatively, have a separated website repository be built from multiple GitHub sources (the source source and examples source).

@MikaelSlevinsky
Copy link
Member Author

Actually, another benefit is that Literate.jl can create Jupyter notebooks from the same source as *.jl => Markdown => HTML. So all the notebooks in this repository could be significantly condensed into Julia scripts (which have a much smaller codeprint).

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

No branches or pull requests

1 participant