From d9b37f82440c3a2ab8d0f1f5627c702805b5ed83 Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Wed, 4 Mar 2020 18:01:26 +0900 Subject: [PATCH 1/5] fix compats --- Project.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Project.toml b/Project.toml index c1052a4..125e17e 100644 --- a/Project.toml +++ b/Project.toml @@ -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] From 4cfcc61fb62b88d1df93013e267be3f4d8bef907 Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Wed, 4 Mar 2020 18:01:36 +0900 Subject: [PATCH 2/5] introduce compat helper --- .github/workflows/CompatHelper.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/CompatHelper.yml diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml new file mode 100644 index 0000000..dd821e6 --- /dev/null +++ b/.github/workflows/CompatHelper.yml @@ -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()' From 4dfa7da71f1b1bb5fa3d9e24a1376d7d748ac76a Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Wed, 4 Mar 2020 19:20:03 +0900 Subject: [PATCH 3/5] update doc deps --- doc/Project.toml | 3 --- doc/make.jl | 21 +++++++++++++++------ 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/doc/Project.toml b/doc/Project.toml index 5921c98..46bdb47 100644 --- a/doc/Project.toml +++ b/doc/Project.toml @@ -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" diff --git a/doc/make.jl b/doc/make.jl index 7e0e726..7777b9b 100644 --- a/doc/make.jl +++ b/doc/make.jl @@ -1,15 +1,24 @@ 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" + target = "build", + push_preview = true, ) From 2aa7cb7ca59c21c39330a1e8db6b9f05bf877596 Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Wed, 4 Mar 2020 19:23:48 +0900 Subject: [PATCH 4/5] several documentation updates --- doc/make_examples.jl | 1 - doc/src/getting_started.md | 14 ++++++++------ doc/src/index.md | 12 ++++++++---- 3 files changed, 16 insertions(+), 11 deletions(-) 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 From c020fea6421db93c17d45a91c07a248857c013b5 Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Wed, 4 Mar 2020 19:37:36 +0900 Subject: [PATCH 5/5] fix matrix&jobs --- .travis.yml | 16 ++++++++-------- doc/make.jl | 1 - 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.travis.yml b/.travis.yml index 054ade6..e6dfb2a 100644 --- a/.travis.yml +++ b/.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 diff --git a/doc/make.jl b/doc/make.jl index 7777b9b..f7abdc1 100644 --- a/doc/make.jl +++ b/doc/make.jl @@ -19,6 +19,5 @@ include("make_examples.jl") deploydocs( repo = "github.com/mpastell/Weave.jl.git", - target = "build", push_preview = true, )