Go to file
Matti Pastell 1d2c108fa9 Fix changes to tests caused by whitespace fix in reader 2016-04-20 19:02:43 +03:00
bin Update syntax for command line scipt and add it to docs 2016-04-20 12:56:06 +03:00
doc Fix changes to tests caused by whitespace fix in reader 2016-04-20 19:02:43 +03:00
examples Fixed extra empty space in first doc chunk, tweaks to html style 2016-04-20 16:32:22 +03:00
src Added md2pdf format 2016-04-20 18:36:26 +03:00
templates Added md2pdf format 2016-04-20 18:36:26 +03:00
test Fix changes to tests caused by whitespace fix in reader 2016-04-20 19:02:43 +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 Added documentation for chunk options 2016-04-20 11:44:36 +03:00
README.md Add test and docs for hold chunk option 2016-04-19 17:07:07 +03:00
REQUIRE First version of documentation with Documenter.jl and mkdocs. Remove Docile depency 2016-04-19 16:10:10 +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 PyPlot, Gadfly figures. (or Winston in 0.0.4)
  • 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"))

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.