diff --git a/doc/make_examples.jl b/doc/make_examples.jl index c256db1..8009ead 100644 --- a/doc/make_examples.jl +++ b/doc/make_examples.jl @@ -25,5 +25,4 @@ if !haskey(ENV, "TRAVIS") weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "build/examples") end - cd(start_dir) diff --git a/doc/src/getting_started.md b/doc/src/getting_started.md index e8aab02..8720397 100644 --- a/doc/src/getting_started.md +++ b/doc/src/getting_started.md @@ -2,15 +2,17 @@ # Getting started The best way to get started using Weave.jl is to look at the example input and -output documents. Examples for different formats are included in the packages `examples` directory. +output documents. Examples for different formats are included in the packages +[`examples`](https://github.com/JunoLab/Weave.jl/tree/master/examples) directory. -First have a look at source document using markdown code chunks and Plots.jl for -figures: [FIR_design.jmd](../examples/FIR_design.jmd) and then see the +First have a look at source document using markdown code chunks and +[Plots.jl](https://github.com/JuliaPlots/Plots.jl) for figures: +[FIR_design.jmd](../examples/FIR_design.jmd) and then see the output in different formats: - - HTML: [FIR_design.html](../examples/FIR_design.html) - - pdf: [FIR_design.pdf](../examples/FIR_design.pdf) - - Pandoc markdown: [FIR_design.txt](../examples/FIR_design.txt) +- HTML: [FIR_design.html](../examples/FIR_design.html) +- pdf: [FIR_design.pdf](../examples/FIR_design.pdf) +- Pandoc markdown: [FIR_design.txt](../examples/FIR_design.txt) *Producing pdf output requires that you have XeLateX installed.* diff --git a/doc/src/index.md b/doc/src/index.md index ed54271..a14d2a0 100644 --- a/doc/src/index.md +++ b/doc/src/index.md @@ -1,9 +1,13 @@ # Weave.jl - Scientific Reports Using Julia -This is the documentation of [Weave.jl](http://github.com/mpastell/weave.jl). Weave is a scientific report generator/literate programming tool -for Julia. It resembles [Pweave](http://mpastell.com/pweave), Knitr, rmarkdown -and Sweave. +This is the documentation of [Weave.jl](http://github.com/mpastell/weave.jl). +Weave is a scientific report generator/literate programming tool for Julia. +It resembles +[Pweave](http://mpastell.com/pweave), +[knitr](https://yihui.org/knitr/), +[R Markdown](https://rmarkdown.rstudio.com/), +and [Sweave](https://stat.ethz.ch/R-manual/R-patched/library/utils/doc/Sweave.pdf). **Current features** @@ -12,7 +16,7 @@ and Sweave. * Publish markdown directly to html and pdf using Julia or Pandoc markdown * Execute code as terminal or "script" chunks * Capture Plots.jl or Gadfly.jl figures -* Supports LaTex, Pandoc, Github markdown, MultiMarkdown, Asciidoc and reStructuredText output +* Supports LaTex, Pandoc, GitHub markdown, MultiMarkdown, Asciidoc and reStructuredText output * Simple caching of results * Convert to and from IJulia notebooks