mirror of https://github.com/mpastell/Weave.jl
commit
ab5db9aa24
|
@ -0,0 +1,19 @@
|
|||
name: CompatHelper
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '00 00 * * *'
|
||||
|
||||
jobs:
|
||||
CompatHelper:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: julia-actions/setup-julia@latest
|
||||
with:
|
||||
version: 1.3
|
||||
- name: Pkg.add("CompatHelper")
|
||||
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
|
||||
- name: CompatHelper.main()
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: julia -e 'using CompatHelper; CompatHelper.main()'
|
16
.travis.yml
16
.travis.yml
|
@ -4,14 +4,7 @@ julia:
|
|||
- 1.0
|
||||
- 1.3
|
||||
- 1.4
|
||||
|
||||
matrix:
|
||||
allow_failures:
|
||||
- julia: 1.4
|
||||
- julia: nightly
|
||||
|
||||
notifications:
|
||||
email: false
|
||||
- nightly
|
||||
|
||||
script:
|
||||
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
|
||||
|
@ -19,7 +12,11 @@ script:
|
|||
- xvfb-run julia -e 'using Pkg; Pkg.test("Weave", coverage=true)'
|
||||
after_success:
|
||||
- julia -e 'using Pkg; cd(Pkg.dir("Weave")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
|
||||
|
||||
jobs:
|
||||
allow_failures:
|
||||
- julia: 1.4
|
||||
- julia: nightly
|
||||
include:
|
||||
- stage: "Documentation"
|
||||
julia: 1.3
|
||||
|
@ -29,3 +26,6 @@ jobs:
|
|||
Pkg.instantiate()'
|
||||
- julia --project=doc/ doc/make.jl
|
||||
after_success: skip
|
||||
|
||||
notifications:
|
||||
email: false
|
||||
|
|
|
@ -17,10 +17,10 @@ Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
|
|||
YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
|
||||
|
||||
[compat]
|
||||
Highlights = ">=0.3.1"
|
||||
Mustache = ">=0.4.1"
|
||||
Plots = ">=0.19.0"
|
||||
YAML = ">=0.3.0"
|
||||
Highlights = "0.3.1, 0.4"
|
||||
Mustache = "0.4.1, 0.5, 1"
|
||||
Plots = "0.19, 0.20, 0.21, 0.22, 0.23, 0.24, 0.25, 0.26, 0.27, 0.28, 0.29"
|
||||
YAML = "0.3"
|
||||
julia = "1"
|
||||
|
||||
[extras]
|
||||
|
|
|
@ -2,6 +2,3 @@
|
|||
DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
|
||||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
|
||||
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
|
||||
|
||||
[compat]
|
||||
Documenter = "~0.20"
|
||||
|
|
20
doc/make.jl
20
doc/make.jl
|
@ -1,15 +1,23 @@
|
|||
using Documenter, Weave
|
||||
|
||||
|
||||
makedocs( modules = Weave, sitename="Weave.jl",
|
||||
pages = ["index.md", "getting_started.md", "usage.md",
|
||||
"publish.md", "chunk_options.md", "notebooks.md",
|
||||
"function_index.md"]
|
||||
makedocs(
|
||||
modules = [Weave],
|
||||
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
|
||||
sitename = "Weave.jl",
|
||||
pages = [
|
||||
"index.md",
|
||||
"getting_started.md",
|
||||
"usage.md",
|
||||
"publish.md",
|
||||
"chunk_options.md",
|
||||
"notebooks.md",
|
||||
"function_index.md",
|
||||
],
|
||||
)
|
||||
|
||||
include("make_examples.jl")
|
||||
|
||||
deploydocs(
|
||||
repo = "github.com/mpastell/Weave.jl.git",
|
||||
target = "build"
|
||||
push_preview = true,
|
||||
)
|
||||
|
|
|
@ -25,5 +25,4 @@ if !haskey(ENV, "TRAVIS")
|
|||
weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "build/examples")
|
||||
end
|
||||
|
||||
|
||||
cd(start_dir)
|
||||
|
|
|
@ -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.*
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in New Issue