Go to file
Matti Pastell 526646bb79 Add hold option for chunks 2016-04-19 16:39:10 +03:00
bin Keeping track of changes 2014-12-20 16:47:45 +02:00
doc Add hold option for chunks 2016-04-19 16:39:10 +03:00
examples Fix md strings and deprecation warning from pgf example 2016-04-12 17:35:58 +03:00
src Add hold option for chunks 2016-04-19 16:39:10 +03:00
test Fixed output format and tests for PyPlot 2016-04-12 17:08:29 +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 Add hold option for chunks 2016-04-19 16:39:10 +03:00
README.md First version of documentation with Documenter.jl and mkdocs. Remove Docile depency 2016-04-19 16:10:10 +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 MKdDocs 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.