Skip to content

Use Literate.jl to incorporate examples into documentation via CI #7

@MikaelSlevinsky

Description

@MikaelSlevinsky

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions