Kaleido (#342)

* ENH: use PlotlyBase's Kaleido for savefig

* OPS: add pkg-butler

* DEPS: depend on plotlyBase 0.4

* ENH: delete pkg-butler  -- we need special CI

* ENH: update travis settings

* WIP: migrate docs to Documenter.jl instead of mkdocs

Author: sglyon

.github/workflows/deploy_docs.yml

@@ -0,0 +1,21 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  docdeploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/julia-buildpkg@latest
+        env:
+          PYTHON: ""
+      - uses: julia-actions/julia-docdeploy@releases/v1
+        env:
+          DOCUMENTER_KEY: ${{ secrets.JLPKGBUTLER_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.travis.yml

@@ -1,24 +1,24 @@
-# Documentation: http://docs.travis-ci.com/user/languages/julia/	
-language: julia	
-sudo: required	
-os:	
-  - linux	
-julia:	
-  - 1.3	
+# Documentation: http://docs.travis-ci.com/user/languages/julia/
+language: julia
+sudo: required
+os:
+  - linux
+julia:
+  - 1.3
   - 1.4
-  - nightly	
-matrix:	
-  allow_failures:	
-    - julia: nightly	
-addons:	
-    apt:	
-        packages:	
-            - xvfb	
-            - xauth	
-            - libgtk-3-0	
-notifications:	
-  email: false	
-# uncomment the following lines to override the default test script	
-script:	
- - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi	
- - xvfb-run julia -e 'using Pkg; Pkg.build(); Pkg.test(coverage=true)'
+  - 1.5
+  - nightly
+matrix:
+  allow_failures:
+    - julia: nightly
+addons:
+    apt:
+        packages:
+            - xvfb
+            - xauth
+            - libgtk-3-0
+notifications:
+  email: false
+# uncomment the following lines to override the default test script
+script:
+ - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi

CHANGELOG.md

@@ -1,7 +1,7 @@
 name = "PlotlyJS"
 uuid = "f0f68f2c-4968-5e81-91da-67840de0976a"
 authors = ["Spencer Lyon <[email protected]>"]
-version = "0.13.1"
+version = "0.14.0"
 
 [deps]
 Blink = "ad839575-38b3-5650-b840-f874b8c74a25"
@@ -22,7 +22,7 @@ Blink = "≥ 0.8.0"
 Compat = "≥ 0.69.0"
 JSExpr = "0.5"
 JSON = "≥ 0.7.0"
-PlotlyBase = "≥ 0.4.0"
+PlotlyBase = "0.4"
 Reexport = "≥ 0.2.0"
 Requires = "1.0"
 WebIO = "≥ 0.8.6"

Project.toml

@@ -0,0 +1,2 @@
+build/
+site/

deploy_docs.sh

@@ -0,0 +1,17 @@
+[deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
+RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[compat]
+PlotlyBase = "0.4.1"

docs/.gitignore

@@ -5,69 +5,81 @@ puts each example from the julia file into a code block and adds
 a short html div below with the interactive output.
 =#
 using PlotlyJS
-using Distributions, Quandl, RDatasets  # used in examples
 
-doc_style = Style(layout=Layout(margin=attr(t=60, b=60, l=50, r=50)))
+# used in examples
+using Distributions, HTTP, DataFrames, RDatasets, Colors, CSV, JSON
+using Random, Dates, LinearAlgebra, DelimitedFiles
 
-# Read all file names in
-this_dir = dirname(@__FILE__)
-if length(ARGS) == 0
-    all_file_names = readdir(joinpath(this_dir, "..", "examples"))
-else
-    all_file_names = [endswith(i, ".jl") ? i : "$(i).jl" for i in ARGS]
-end
-
-nfiles = length(all_file_names)
 
-# Check whether files are julia files and select julia files
-cft(x) = x[end-2:end]==".jl" ? true : false
-am_i_julia_file = map(cft, all_file_names)
-all_julia_files = all_file_names[am_i_julia_file]
-for i in all_julia_files
-    println(i)
-    include(joinpath(this_dir, "..", "examples", i))
-end
+const THIS_DIR = dirname(@__FILE__)
 
-use_style!(doc_style)
 
 # Walk through each example in a file and get the markdown from `single_example`
-function single_file(filename::String)
+function single_example_file(filename::String)
+    base_fn = split(filename, ".")[1]
+    start_example = "```@example $(base_fn)"
+    end_example = "```"
     # Open a file to write to
-    open(joinpath(this_dir, "examples", filename[1:end-3]*".md"), "w") do outfile
+    open(joinpath(THIS_DIR, "src", "examples", "$(base_fn).md"), "w") do outfile
 
-    # Read lines from a files
-    fulltext = open(f->read(f, String), joinpath(this_dir, "..", "examples", filename), "r")
-    all_lines = split(fulltext, "\n")
-    l = 1
-    regex = r"^function ([^_].+?)\("
-    regex_end = r"^end$"
+        write_example(ex) = println(outfile, start_example, "\n", ex, "\n", end_example, "\n")
 
-    while true
-        # Find next function name (break if none)
-        l = findnext(x -> match(regex, x) != nothing, all_lines, l+1)
-        if l == 0
-            break
-        end
-        # find corresponding end for this function
-        end_l = findnext(x -> match(regex_end, x) != nothing, all_lines, l+1)
+        fn_h1 = titlecase(replace(base_fn, "_" => " "))
+        println(outfile, "# $(fn_h1)\n")
 
-        # Pull out function text
-        func_block = join(all_lines[l:end_l], "\n")
-        fun_name = match(regex, all_lines[l])[1]
+        # Read lines from a files
+        fulltext = open(
+            f->read(f, String),
+            joinpath(THIS_DIR, "..", "examples", filename),
+            "r"
+        )
+        all_lines = split(fulltext, "\n")
+        l = 1
+        regex = r"^function ([^_].+?)\("
+        regex_end = r"^end$"
 
-        println("adding $fun_name")
+        # find preamble
+        if base_fn == "subplots"  # special case
+            preamble = "using PlotlyJS, Dates\ninclude(\"../../../examples/line_scatter.jl\")"
+            write_example(preamble)
+        else
+            first_line = findfirst(x -> match(regex, x) !== nothing, all_lines)
+            if first_line !== nothing
+                preamble = strip(join(all_lines[1:first_line-1], "\n"))
+                write_example(preamble)
+            end
+        end
 
-        # Get html block
-        plt = eval(Expr(:call, Symbol(fun_name))).plot
-        relayout!(plt, margin=attr(t=60, b=60, l=50, r=50))
-        html_block = PlotlyJS.html_body(plt)
+        while true
+            # Find next function name (break if none)
+            l = findnext(x -> match(regex, x) !== nothing, all_lines, l+1)
+            if l == 0 || l === nothing
+                break
+            end
+            # find corresponding end for this function
+            end_l = findnext(x -> match(regex_end, x) !== nothing, all_lines, l+1)
 
-        println(outfile, "```julia\n$func_block\n$(fun_name)()\n```\n\n\n$html_block\n\n")
-        l = end_l
-    end
+            # Pull out function text
+            func_block = join(all_lines[l:end_l], "\n")
+            fun_name = match(regex, all_lines[l])[1]
+            # println("adding $fun_name")
+            an_ex = string(func_block, "\n", fun_name, "()")
+            write_example(an_ex)
+            l = end_l
+        end
     end  # do outfile
 
     return nothing
 end
 
-main() = map(single_file, all_julia_files)
+function main()
+    # Read all file names in
+    if length(ARGS) == 0
+        all_file_names = readdir(joinpath(THIS_DIR, "..", "examples"))
+    else
+        all_file_names = [endswith(i, ".jl") ? i : "$(i).jl" for i in ARGS]
+    end
+    all_julia_files = filter(x -> endswith(x, ".jl"), all_file_names)
+
+    foreach(single_example_file, all_julia_files)
+end