Go to file
= 13670b1620 Allow out_path to be file or directory 2016-04-24 15:02:03 +03:00
bin Implement autodetecting output format 2016-04-22 16:16:12 +03:00
doc Added documentation about new features 2016-04-22 16:16:50 +03:00
examples Make mathjax work with sef-contained pandoc, fix a bug in script reader 2016-04-22 13:18:33 +03:00
src Allow out_path to be file or directory 2016-04-24 15:02:03 +03:00
templates Make mathjax work with sef-contained pandoc, fix a bug in script reader 2016-04-22 13:18:33 +03:00
test Allow out_path to be file or directory 2016-04-24 15:02:03 +03:00
.gitignore First version of documentation with Documenter.jl and mkdocs. Remove Docile depency 2016-04-19 16:10:10 +03:00
.travis.yml Update conda path in travis 2016-04-11 19:15:39 +03:00
LICENSE.md Renamed package to Weave,jl as discussed in mpastell:pull-request/54b50af2 2014-12-08 10:31:03 +02:00
NEWS.md Allow out_path to be file or directory 2016-04-24 15:02:03 +03:00
README.md Improved examples 2016-04-20 22:19:01 +03:00
REQUIRE Fix to deserialing cached content. Caching now works as previously documented and tests pass 2016-04-23 19:19:38 +03:00

README.md

Weave

Build StatusCoverage Status

Weave is a scientific report generator/literate programming tool for Julia. It resembles Pweave and, Knitr and Sweave.

You can write your documentation and code in input document using Nowed or Markdown syntax and use weave function to execute to document to capture results and figures.

Current features

  • Noweb or markdown syntax for input documents.
  • Execute code as terminal or "script" chunks.
  • Capture Gadfly, PyPlot and Winston figures.
  • Supports LaTex, Pandoc and Github markdown and reStructuredText output

Usage

Run from julia using Gadfly for plots:

using Weave
weave(Pkg.dir("Weave","examples","gadfly_sample.mdw"))

If you have Pandoc installed you can also weave directly to html and pdf.

weave(Pkg.dir("Weave","examples","gadfly_md_sample.jmd"), informat="markdown",
  out_path = :pwd, doctype = "md2html")

Weave code and output

Documentation

Documenter.jl with MKDocs generated documentation:

Contributing

I will probably add new features to Weave when I need them myself or if they are requested and not too difficult to implement. You can contribute by opening issues on Github or implementing things yourself and making a pull request. I'd also appreciate example documents written using Weave to add to examples.

Contributors

You can see the list of contributors on Github: https://github.com/mpastell/Weave.jl/graphs/contributors. Thanks for the important additions, fixes and comments.