mirrors
/
Weave.jl
mirror of https://github.com/mpastell/Weave.jl
1
0
Fork 0
Code Issues Releases Wiki Activity

several documentation updates

pull/279/head
Shuhei Kadowaki 2020-03-04 19:23:48 +09:00
parent 4dfa7da71f
commit 2aa7cb7ca5
3 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/make_examples.jl
View File

@ -25,5 +25,4 @@ if !haskey(ENV, "TRAVIS")
weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "build/examples") weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "build/examples")
end end
cd(start_dir) cd(start_dir)

14
doc/src/getting_started.md
View File

@ -2,15 +2,17 @@
# Getting started # Getting started
The best way to get started using Weave.jl is to look at the example input and 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 First have a look at source document using markdown code chunks and
figures: [FIR_design.jmd](../examples/FIR_design.jmd) and then see the [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: output in different formats:
- HTML: [FIR_design.html](../examples/FIR_design.html) - HTML: [FIR_design.html](../examples/FIR_design.html)
- pdf: [FIR_design.pdf](../examples/FIR_design.pdf) - pdf: [FIR_design.pdf](../examples/FIR_design.pdf)
- Pandoc markdown: [FIR_design.txt](../examples/FIR_design.txt) - Pandoc markdown: [FIR_design.txt](../examples/FIR_design.txt)
*Producing pdf output requires that you have XeLateX installed.* *Producing pdf output requires that you have XeLateX installed.*

12
doc/src/index.md
View File

@ -1,9 +1,13 @@
# Weave.jl - Scientific Reports Using Julia # 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 This is the documentation of [Weave.jl](http://github.com/mpastell/weave.jl).
for Julia. It resembles [Pweave](http://mpastell.com/pweave), Knitr, rmarkdown Weave is a scientific report generator/literate programming tool for Julia.
and Sweave. 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** **Current features**
@ -12,7 +16,7 @@ and Sweave.
* Publish markdown directly to html and pdf using Julia or Pandoc markdown * Publish markdown directly to html and pdf using Julia or Pandoc markdown
* Execute code as terminal or "script" chunks * Execute code as terminal or "script" chunks
* Capture Plots.jl or Gadfly.jl figures * 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 * Simple caching of results
* Convert to and from IJulia notebooks * Convert to and from IJulia notebooks