Go to file
Matti Pastell 5d1f5ab4d7 Refactoring to cleaner API. Added WeaveDoc type.
Reading and running chunks now return WeaveDoc's.
Cleaned weave function significantly.
2015-01-07 00:01:25 +02:00
bin Keeping track of changes 2014-12-20 16:47:45 +02:00
doc Changed line wrapping added tests for it. Fixes #27. 2015-01-05 23:15:39 +02:00
examples Implemented asciidoc formatter, closes #16 2014-12-20 17:36:02 +02:00
src Refactoring to cleaner API. Added WeaveDoc type. 2015-01-07 00:01:25 +02:00
test Changed line wrapping added tests for it. Fixes #27. 2015-01-05 23:15:39 +02:00
.gitignore Added test for asciidoc output 2014-12-22 17:23:20 +02:00
.travis.yml Fix to travis #4; Can't seem to get Winston test to run 2015-01-05 23:54:07 +02: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 Changed line wrapping added tests for it. Fixes #27. 2015-01-05 23:15:39 +02:00
README.md Added link to 0.0.4 docs in Readme 2015-01-04 14:50:27 +02:00
REQUIRE Changed line wrapping added tests for it. Fixes #27. 2015-01-05 23:15:39 +02: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 or 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"))

Documentation

Lexicon.jl generated documentation for v0.0.4 and master.

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.