Skip to content

Commit

Permalink
Tweak documentation setup
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf committed Sep 26, 2019
1 parent b226a56 commit a9b2883
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -9,13 +9,13 @@
### Example

```julia
using VegaStreams
using VegaLite
julia> using VegaStreams
using VegaLite

vls = vegastream(@vlplot(:line, x=:x, y=:y))
julia> vls = vegastream(@vlplot(:line, x=:x, y=:y));

for (x, y) in enumerate(randn(100))
sleep(0.01)
push!(vls, (x=x, y=y))
end
julia> for (x, y) in enumerate(randn(100))
sleep(0.01)
push!(vls, (x=x, y=y))
end
```
1 change: 0 additions & 1 deletion docs/make.jl
Expand Up @@ -9,7 +9,6 @@ makedocs(;
repo="https://github.com/tkf/VegaStreams.jl/blob/{commit}{path}#L{line}",
sitename="VegaStreams.jl",
authors="Takafumi Arakaki <aka.tkf@gmail.com>",
assets=String[],
)

deploydocs(;
Expand Down
6 changes: 6 additions & 0 deletions src/VegaStreams.jl
@@ -1,5 +1,11 @@
module VegaStreams

# Use README as the docstring of the module:
@doc let path = joinpath(dirname(@__DIR__), "README.md")
include_dependency(path)
replace(read(path, String), r"^```julia"m => "```jldoctest README")
end VegaStreams

export vegastream

using Electron
Expand Down

0 comments on commit a9b2883

Please sign in to comment.