Skip to content

tejasramdas/ScriptReports.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ScriptReports.jl

ScriptReports.jl is a Julia package that allows you to create reports from Julia scripts using a combination of Literate.jl and Weave.jl. LiterateWeave.jl does something similar, but I added a few more features including hiding source code and using <details> blocks.

Usage

This package exports a single function called generate_report that takes in a .jl file interleaved with Markdown, runs it through Literate to generate a .jmd file with some modifications, and then runs it through Weave to generate an HTML file. It supports additional decorators to allow for hiding source code and using <details> blocks. This will hopefully support more source file parsing and customization in the future.

See the examples folder for a quick tutorial. The final output looks something like this.

Credits

Thanks to the developers of Literate and Weave for two awesome packages. Thanks also to baggepinnen for their package and to mtfishman for this snippet.

About

Generate HTML reports directly from Julia scripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published