Browse Source

respect semicolon output supression when exporting to Documenter (#82)

pull/83/head
Kristoffer Carlsson 6 years ago committed by Fredrik Ekre
parent
commit
72a94ac8ac
  1. 29
      docs/Manifest.toml
  2. 3
      examples/example.jl
  3. 5
      src/Literate.jl
  4. 12
      test/runtests.jl

29
docs/Manifest.toml

@ -21,12 +21,6 @@ git-tree-sha1 = "c9c1845d6bf22e34738bee65c357a69f416ed5d1"
uuid = "5ae59095-9a9b-59fe-a467-6f913c188581" uuid = "5ae59095-9a9b-59fe-a467-6f913c188581"
version = "0.9.6" version = "0.9.6"
[[Compat]]
deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
git-tree-sha1 = "ed2c4abadf84c53d9e58510b5fc48912c2336fbb"
uuid = "34da2185-b29b-5c13-b0c7-acf172513d20"
version = "2.2.0"
[[Contour]] [[Contour]]
deps = ["LinearAlgebra", "StaticArrays", "Test"] deps = ["LinearAlgebra", "StaticArrays", "Test"]
git-tree-sha1 = "b974e164358fea753ef853ce7bad97afec15bb80" git-tree-sha1 = "b974e164358fea753ef853ce7bad97afec15bb80"
@ -64,8 +58,8 @@ version = "0.8.1"
[[Documenter]] [[Documenter]]
deps = ["Base64", "Dates", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] deps = ["Base64", "Dates", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
git-tree-sha1 = "b91ebc59dde60db109e618b39b43da7211c31a35" git-tree-sha1 = "fb16819c1bcf5e99b8e316e329e5e0958550334e"
repo-rev = "fe/gh-status" repo-rev = "master"
repo-url = "https://github.com/JuliaDocs/Documenter.jl.git" repo-url = "https://github.com/JuliaDocs/Documenter.jl.git"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.24.0-DEV" version = "0.24.0-DEV"
@ -98,9 +92,9 @@ deps = ["Markdown"]
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
[[IterTools]] [[IterTools]]
git-tree-sha1 = "2ebe60d7343962966d1779a74a760f13217a6901" git-tree-sha1 = "05110a2ab1fc5f932622ffea2a003221f4782c18"
uuid = "c8e1da08-722c-5040-9ed9-7db0dc04731e" uuid = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
version = "1.2.0" version = "1.3.0"
[[JSON]] [[JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"] deps = ["Dates", "Mmap", "Parsers", "Unicode"]
@ -147,10 +141,9 @@ version = "0.4.3"
uuid = "a63ad114-7e13-5084-954f-fe012c677804" uuid = "a63ad114-7e13-5084-954f-fe012c677804"
[[NaNMath]] [[NaNMath]]
deps = ["Compat"] git-tree-sha1 = "928b8ca9b2791081dc71a51c55347c27c618760f"
git-tree-sha1 = "ce3b85e484a5d4c71dd5316215069311135fa9f2"
uuid = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3" uuid = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
version = "0.3.2" version = "0.3.3"
[[OrderedCollections]] [[OrderedCollections]]
deps = ["Random", "Serialization", "Test"] deps = ["Random", "Serialization", "Test"]
@ -160,12 +153,12 @@ version = "1.1.0"
[[Parsers]] [[Parsers]]
deps = ["Dates", "Test"] deps = ["Dates", "Test"]
git-tree-sha1 = "c56ecb484f286639f161e712b8311f5ab77e8d32" git-tree-sha1 = "a23968e107c0544aca91bfab6f7dd34de1206a54"
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
version = "0.3.8" version = "0.3.9"
[[Pkg]] [[Pkg]]
deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
[[PlotThemes]] [[PlotThemes]]
@ -221,10 +214,6 @@ uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
[[Serialization]] [[Serialization]]
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
[[SharedArrays]]
deps = ["Distributed", "Mmap", "Random", "Serialization"]
uuid = "1a1011a3-84de-559e-8e89-a11a2f7dc383"
[[Showoff]] [[Showoff]]
deps = ["Dates"] deps = ["Dates"]
git-tree-sha1 = "e032c9df551fb23c9f98ae1064de074111b7bc39" git-tree-sha1 = "e032c9df551fb23c9f98ae1064de074111b7bc39"

3
examples/example.jl

@ -71,6 +71,9 @@ end
foo() foo()
# Just like in the REPL, outputs ending with a semicolon hides the output:
1 + 1;
# Both Documenter's `@example` block and notebooks can display images. Here is an example # Both Documenter's `@example` block and notebooks can display images. Here is an example
# where we generate a simple plot using the # where we generate a simple plot using the
# [Plots.jl](https://github.com/JuliaPlots/Plots.jl) package # [Plots.jl](https://github.com/JuliaPlots/Plots.jl) package

5
src/Literate.jl

@ -408,8 +408,13 @@ function markdown(inputfile, outputdir; preprocess = identity, postprocess = ide
write(iomd, "; continued = true") write(iomd, "; continued = true")
end end
write(iomd, '\n') write(iomd, '\n')
last_line = ""
for line in chunk.lines for line in chunk.lines
write(iomd, line, '\n') write(iomd, line, '\n')
last_line = line
end
if documenter && REPL.ends_with_semicolon(last_line)
write(iomd, "nothing #hide\n")
end end
write(iomd, codefence.second, '\n') write(iomd, codefence.second, '\n')
end end

12
test/runtests.jl

@ -221,6 +221,9 @@ content = """
## Indented comment ## Indented comment
end end
# Semicolon output supression
1 + 1;
#nb # A notebook cell with special metadata #nb # A notebook cell with special metadata
#nb %% Meta1 {"meta": "data"} #nb %% Meta1 {"meta": "data"}
#nb 1+1 #nb 1+1
@ -279,6 +282,8 @@ const expansion_warning = get(ENV, "HAS_JOSH_K_SEAL_OF_APPROVAL", "") == "true"
# Indented comment # Indented comment
end end
1 + 1;
# This file was generated using Literate.jl, https://github.com/fredrikekre/Literate.jl # This file was generated using Literate.jl, https://github.com/fredrikekre/Literate.jl
""" """
@ -458,6 +463,13 @@ end
end end
``` ```
Semicolon output supression
```@example inputfile
1 + 1;
nothing #hide
```
*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).* *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*
""" """

Loading…
Cancel
Save