Go to file
Matti Pastell 06c5933cd1 Moved stuff from README to Docs 2015-01-02 17:40:14 +02:00
bin Keeping track of changes 2014-12-20 16:47:45 +02:00
doc More documentation 2015-01-02 17:05:40 +02:00
examples Implemented asciidoc formatter, closes #16 2014-12-20 17:36:02 +02:00
src More documentation 2015-01-02 17:05:40 +02:00
test Exclude segfaulting test from runtests.jl 2015-01-02 13:44:53 +02:00
.gitignore Added test for asciidoc output 2014-12-22 17:23:20 +02:00
.travis.yml Exclude 0.3 from Travis 2015-01-02 13:51:02 +02:00
LICENSE.md Renamed package to Weave,jl as discussed in mpastell:pull-request/54b50af2 2014-12-08 10:31:03 +02:00
README.md Moved stuff from README to Docs 2015-01-02 17:40:14 +02:00
RELEASE.md AsciiDoc formatter to release notes 2014-12-20 17:37:22 +02:00
REQUIRE Added docstrings using Docile.jl 2015-01-01 23:32:15 +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 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.