diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7373e35..315c305 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -30,7 +30,13 @@ jobs: - uses: julia-actions/setup-julia@v1 with: version: ${{ matrix.version }} - - uses: julia-actions/julia-buildpkg@v1 + - uses: actions/cache@v3 + with: + path: | + ~/.julia/artifacts + ~/.julia/packages + ~/.julia/registries + key: .julia-test-${{ matrix.version }}-${{ hashFiles('Project.toml') }} - uses: julia-actions/julia-runtest@v1 - uses: julia-actions/julia-processcoverage@v1 - uses: codecov/codecov-action@v1 @@ -44,6 +50,13 @@ jobs: - uses: julia-actions/setup-julia@v1 with: version: '1' + - uses: actions/cache@v3 + with: + path: | + ~/.julia/artifacts + ~/.julia/packages + ~/.julia/registries + key: .julia-docs-${{ hashFiles('docs/Project.toml', 'docs/Manifest.toml') }} - name: Install dependencies run: julia --project=docs -e 'using Pkg; Pkg.instantiate()' - name: Build and deploy diff --git a/CHANGELOG.md b/CHANGELOG.md index 9059311..1ba092f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [2.14.0] - 2022-09-22 +### Changed +- Image filenames resulting from executing markdown files + (`Literate.markdown(...; execute=true)`) have changed from a number based on + the hash of the source block to the format + `{name}-{blocknumber}.(svg|png|...)`. ([#204][github-204], + [#205][github-205]) + ## [2.13.4] - 2022-06-03 ### Fixed - Automatic head branch detection (introduced in version 2.11.0) caused a performance @@ -230,8 +238,11 @@ https://discourse.julialang.org/t/ann-literate-jl/10651 for release announcement [github-194]: https://github.com/fredrikekre/Literate.jl/pull/194 [github-195]: https://github.com/fredrikekre/Literate.jl/pull/195 [github-197]: https://github.com/fredrikekre/Literate.jl/issues/197 +[github-204]: https://github.com/fredrikekre/Literate.jl/issues/204 +[github-205]: https://github.com/fredrikekre/Literate.jl/pull/205 -[Unreleased]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.4...HEAD +[Unreleased]: https://github.com/fredrikekre/Literate.jl/compare/v2.14.0...HEAD +[2.14.0]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.3...v2.14.0 [2.13.4]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.3...v2.13.4 [2.13.3]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.2...v2.13.3 [2.13.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.13.1...v2.13.2 diff --git a/Project.toml b/Project.toml index 752136f..3347508 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "Literate" uuid = "98b081ad-f1c9-55d3-8b20-4c87d4299306" -version = "2.13.4" +version = "2.14.0" [deps] Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" diff --git a/README.md b/README.md index b90c109..e83ced4 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,10 @@ using Literate Literate.markdown("examples/README.jl", "."; flavor=Literate.CommonMarkFlavor()) ```` +### Related packages + +- [Weave.jl](https://github.com/JunoLab/Weave.jl) + [docs-img]: https://img.shields.io/badge/docs-latest%20release-blue.svg [docs-url]: https://fredrikekre.github.io/Literate.jl/ diff --git a/docs/Manifest.toml b/docs/Manifest.toml index b2debfd..c014a18 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -5,14 +5,14 @@ git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9" version = "0.0.1" -[[Adapt]] -deps = ["LinearAlgebra"] -git-tree-sha1 = "af92965fb30777147966f58acb05da51c5616b5f" -uuid = "79e6a3ab-5dfb-504d-930d-738a2a938a0e" -version = "3.3.3" +[[AbstractTrees]] +git-tree-sha1 = "5c0b629df8a5566a06f5fef5100b53ea56e465a0" +uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c" +version = "0.4.2" [[ArgTools]] uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f" +version = "1.1.1" [[Artifacts]] uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33" @@ -20,6 +20,11 @@ uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33" [[Base64]] uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" +[[BitFlags]] +git-tree-sha1 = "84259bb6172806304b9101094a7cc4bc6f56dbc6" +uuid = "d1d4a3ce-64b1-5f1a-9ba4-7e7e69966f35" +version = "0.1.5" + [[Bzip2_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] git-tree-sha1 = "19a35467a82e236ff51bc17a3a44b69ef35185a2" @@ -34,9 +39,9 @@ version = "1.16.1+1" [[ChainRulesCore]] deps = ["Compat", "LinearAlgebra", "SparseArrays"] -git-tree-sha1 = "80ca332f6dcb2508adba68f22f551adb2d00a624" +git-tree-sha1 = "dc4405cee4b2fe9e1108caec2d760b7ea758eca2" uuid = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4" -version = "1.15.3" +version = "1.15.5" [[ChangesOfVariables]] deps = ["ChainRulesCore", "LinearAlgebra", "Test"] @@ -76,13 +81,14 @@ version = "0.12.8" [[Compat]] deps = ["Dates", "LinearAlgebra", "UUIDs"] -git-tree-sha1 = "924cdca592bc16f14d2f7006754a621735280b74" +git-tree-sha1 = "5856d3031cdb1f3b2b6340dfdc66b6d9a149a374" uuid = "34da2185-b29b-5c13-b0c7-acf172513d20" -version = "4.1.0" +version = "4.2.0" [[CompilerSupportLibraries_jll]] deps = ["Artifacts", "Libdl"] uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae" +version = "0.5.2+0" [[Contour]] git-tree-sha1 = "d05d9e7b7aedff4e5b51a029dced05cfb6125781" @@ -90,9 +96,9 @@ uuid = "d38c429a-6771-53c6-b99e-75d170b6e991" version = "0.6.2" [[DataAPI]] -git-tree-sha1 = "fb5f5316dd3fd4c5e7c30a24d50643b73e37cd40" +git-tree-sha1 = "1106fa7e1256b402a86a8e7b15c00c85036fef49" uuid = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a" -version = "1.10.0" +version = "1.11.0" [[DataStructures]] deps = ["Compat", "InteractiveUtils", "OrderedCollections"] @@ -100,11 +106,6 @@ git-tree-sha1 = "d1fff3a548102f48987a52a2e0d114fa97d730f0" uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" version = "0.18.13" -[[DataValueInterfaces]] -git-tree-sha1 = "bfc1187b79289637fa0ef6d4436ebdfe6905cbd6" -uuid = "e2d170a0-9d28-54be-80f0-106bbe20a464" -version = "1.0.0" - [[Dates]] deps = ["Printf"] uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" @@ -115,27 +116,22 @@ uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab" [[DocStringExtensions]] deps = ["LibGit2"] -git-tree-sha1 = "b19534d1895d702889b219c382a6e18010797f0b" +git-tree-sha1 = "5158c2b41018c5f7eb1470d558127ac274eca0c9" uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.8.6" +version = "0.9.1" [[Documenter]] -deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] -git-tree-sha1 = "7c98cab82668f33299b195c1940690b2ec3a0ac2" +deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "REPL", "Test", "Unicode"] +git-tree-sha1 = "62c1327407c2ef5f7ea2f9c570485a1f89099e61" repo-rev = "master" repo-url = "https://github.com/JuliaDocs/Documenter.jl.git" uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" version = "0.28.0-DEV" [[Downloads]] -deps = ["ArgTools", "LibCURL", "NetworkOptions"] +deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"] uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6" - -[[EarCut_jll]] -deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] -git-tree-sha1 = "3f3a2501fa7236e9b911e0f7a588c657e822bb6d" -uuid = "5ae413db-bbd1-5e63-b57d-d24a61df00f5" -version = "2.2.3+0" +version = "1.6.0" [[Expat_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -150,10 +146,13 @@ uuid = "c87230d0-a227-11e9-1b43-d7ebe4e7570a" version = "0.4.1" [[FFMPEG_jll]] -deps = ["Artifacts", "Bzip2_jll", "FreeType2_jll", "FriBidi_jll", "JLLWrappers", "LAME_jll", "Libdl", "Ogg_jll", "OpenSSL_jll", "Opus_jll", "Pkg", "Zlib_jll", "libaom_jll", "libass_jll", "libfdk_aac_jll", "libvorbis_jll", "x264_jll", "x265_jll"] -git-tree-sha1 = "ccd479984c7838684b3ac204b716c89955c76623" +deps = ["Artifacts", "Bzip2_jll", "FreeType2_jll", "FriBidi_jll", "JLLWrappers", "LAME_jll", "Libdl", "Ogg_jll", "OpenSSL_jll", "Opus_jll", "PCRE2_jll", "Pkg", "Zlib_jll", "libaom_jll", "libass_jll", "libfdk_aac_jll", "libvorbis_jll", "x264_jll", "x265_jll"] +git-tree-sha1 = "74faea50c1d007c85837327f6775bea60b5492dd" uuid = "b22a6f82-2f65-5046-a5b2-351ab43fb4e5" -version = "4.4.2+0" +version = "4.4.2+2" + +[[FileWatching]] +uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee" [[FixedPointNumbers]] deps = ["Statistics"] @@ -187,27 +186,21 @@ version = "1.0.10+0" [[GLFW_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Libglvnd_jll", "Pkg", "Xorg_libXcursor_jll", "Xorg_libXi_jll", "Xorg_libXinerama_jll", "Xorg_libXrandr_jll"] -git-tree-sha1 = "51d2dfe8e590fbd74e7a842cf6d13d8a2f45dc01" +git-tree-sha1 = "d972031d28c8c8d9d7b41a536ad7bb0c2579caca" uuid = "0656b61e-2033-5cc2-a64a-77c0f6c09b89" -version = "3.3.6+0" +version = "3.3.8+0" [[GR]] deps = ["Base64", "DelimitedFiles", "GR_jll", "HTTP", "JSON", "Libdl", "LinearAlgebra", "Pkg", "Printf", "Random", "RelocatableFolders", "Serialization", "Sockets", "Test", "UUIDs"] -git-tree-sha1 = "037a1ca47e8a5989cc07d19729567bb71bfabd0c" +git-tree-sha1 = "cf0a9940f250dc3cb6cc6c6821b4bf8a4286cf9c" uuid = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71" -version = "0.66.0" +version = "0.66.2" [[GR_jll]] deps = ["Artifacts", "Bzip2_jll", "Cairo_jll", "FFMPEG_jll", "Fontconfig_jll", "GLFW_jll", "JLLWrappers", "JpegTurbo_jll", "Libdl", "Libtiff_jll", "Pixman_jll", "Pkg", "Qt5Base_jll", "Zlib_jll", "libpng_jll"] -git-tree-sha1 = "c8ab731c9127cd931c93221f65d6a1008dad7256" +git-tree-sha1 = "0eb5ef6f270fb70c2d83ee3593f56d02ed6fc7ff" uuid = "d2c73de3-f751-5644-a686-071e5b155ba9" -version = "0.66.0+0" - -[[GeometryBasics]] -deps = ["EarCut_jll", "IterTools", "LinearAlgebra", "StaticArrays", "StructArrays", "Tables"] -git-tree-sha1 = "83ea630384a13fc4f002b77690bc0afeb4255ac9" -uuid = "5c1252a2-5f33-56bf-86c9-59e7332b4326" -version = "0.4.2" +version = "0.68.0+0" [[Gettext_jll]] deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Libiconv_jll", "Pkg", "XML2_jll"] @@ -233,10 +226,10 @@ uuid = "42e2da0e-8278-4e71-bc24-59509adca0fe" version = "1.0.2" [[HTTP]] -deps = ["Base64", "CodecZlib", "Dates", "IniFile", "Logging", "LoggingExtras", "MbedTLS", "NetworkOptions", "Random", "SimpleBufferStream", "Sockets", "URIs", "UUIDs"] -git-tree-sha1 = "ed47af35905b7cc8f1a522ca684b35a212269bd8" +deps = ["Base64", "CodecZlib", "Dates", "IniFile", "Logging", "LoggingExtras", "MbedTLS", "NetworkOptions", "OpenSSL", "Random", "SimpleBufferStream", "Sockets", "URIs", "UUIDs"] +git-tree-sha1 = "4abede886fcba15cd5fd041fef776b230d004cee" uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3" -version = "1.2.0" +version = "1.4.0" [[HarfBuzz_jll]] deps = ["Artifacts", "Cairo_jll", "Fontconfig_jll", "FreeType2_jll", "Glib_jll", "Graphite2_jll", "JLLWrappers", "Libdl", "Libffi_jll", "Pkg"] @@ -270,16 +263,6 @@ git-tree-sha1 = "7fd44fd4ff43fc60815f8e764c0f352b83c49151" uuid = "92d709cd-6900-40b7-9082-c6be49f344b6" version = "0.1.1" -[[IterTools]] -git-tree-sha1 = "fa6287a4469f5e048d763df38279ee729fbd44e5" -uuid = "c8e1da08-722c-5040-9ed9-7db0dc04731e" -version = "1.4.0" - -[[IteratorInterfaceExtensions]] -git-tree-sha1 = "a3f24677c21f5bbe9d2a714f95dcd58337fb2856" -uuid = "82899510-4779-5014-852e-03e436cf321d" -version = "1.0.0" - [[JLLWrappers]] deps = ["Preferences"] git-tree-sha1 = "abc9885a7ca2052a736a600f7fa66209f96506e1" @@ -322,18 +305,20 @@ uuid = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f" version = "1.3.0" [[Latexify]] -deps = ["Formatting", "InteractiveUtils", "LaTeXStrings", "MacroTools", "Markdown", "Printf", "Requires"] -git-tree-sha1 = "1a43be956d433b5d0321197150c2f94e16c0aaa0" +deps = ["Formatting", "InteractiveUtils", "LaTeXStrings", "MacroTools", "Markdown", "OrderedCollections", "Printf", "Requires"] +git-tree-sha1 = "ab9aa169d2160129beb241cb2750ca499b4e90e9" uuid = "23fbe1c1-3f47-55db-b15f-69d7ec21a316" -version = "0.15.16" +version = "0.15.17" [[LibCURL]] deps = ["LibCURL_jll", "MozillaCACerts_jll"] uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21" +version = "0.6.3" [[LibCURL_jll]] deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"] uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0" +version = "7.84.0+0" [[LibGit2]] deps = ["Base64", "NetworkOptions", "Printf", "SHA"] @@ -342,6 +327,7 @@ uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" [[LibSSH2_jll]] deps = ["Artifacts", "Libdl", "MbedTLS_jll"] uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8" +version = "1.10.2+0" [[Libdl]] uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" @@ -402,13 +388,13 @@ uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" deps = ["Base64", "IOCapture", "JSON", "REPL"] path = ".." uuid = "98b081ad-f1c9-55d3-8b20-4c87d4299306" -version = "2.13.4" +version = "2.14.0" [[LogExpFunctions]] deps = ["ChainRulesCore", "ChangesOfVariables", "DocStringExtensions", "InverseFunctions", "IrrationalConstants", "LinearAlgebra"] -git-tree-sha1 = "7c88f63f9f0eb5929f15695af9a4d7d3ed278a91" +git-tree-sha1 = "94d9c52ca447e23eac0c0f074effbcd38830deb5" uuid = "2ab3a3ac-af41-5b50-aa03-7779005ae688" -version = "0.3.16" +version = "0.3.18" [[Logging]] uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" @@ -429,15 +415,22 @@ version = "0.5.9" deps = ["Base64"] uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" +[[MarkdownAST]] +deps = ["AbstractTrees", "Markdown"] +git-tree-sha1 = "2444ff682d19291efd5944578258fc9657f1450f" +uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391" +version = "0.0.2" + [[MbedTLS]] deps = ["Dates", "MbedTLS_jll", "MozillaCACerts_jll", "Random", "Sockets"] -git-tree-sha1 = "9f4f5a42de3300439cb8300236925670f844a555" +git-tree-sha1 = "6872f9594ff273da6d13c7c1a1545d5a8c7d0c1c" uuid = "739be429-bea8-5141-9913-cc70e7f3736d" -version = "1.1.1" +version = "1.1.6" [[MbedTLS_jll]] deps = ["Artifacts", "Libdl"] uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1" +version = "2.28.0+0" [[Measures]] git-tree-sha1 = "e498ddeee6f9fdb4551ce855a46f54dbd900245f" @@ -455,6 +448,7 @@ uuid = "a63ad114-7e13-5084-954f-fe012c677804" [[MozillaCACerts_jll]] uuid = "14a3606d-f60d-562e-9121-12d972cd8159" +version = "2022.2.1" [[NaNMath]] deps = ["OpenLibm_jll"] @@ -464,6 +458,7 @@ version = "1.0.1" [[NetworkOptions]] uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" +version = "1.2.0" [[Ogg_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -474,10 +469,18 @@ version = "1.3.5+1" [[OpenBLAS_jll]] deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"] uuid = "4536629a-c528-5b80-bd46-f80d51c5b363" +version = "0.3.20+0" [[OpenLibm_jll]] deps = ["Artifacts", "Libdl"] uuid = "05823500-19ac-5b8b-9628-191a04bc5112" +version = "0.8.1+0" + +[[OpenSSL]] +deps = ["BitFlags", "Dates", "MozillaCACerts_jll", "OpenSSL_jll", "Sockets"] +git-tree-sha1 = "fa44e6aa7dfb963746999ca8129c1ef2cf1c816b" +uuid = "4d8831e6-92b7-49fb-bdf8-b643e874388c" +version = "1.1.1" [[OpenSSL_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -502,6 +505,11 @@ git-tree-sha1 = "85f8e6578bf1f9ee0d11e7bb1b1456435479d47c" uuid = "bac558e1-5e72-5ebc-8fee-abe8a469f55d" version = "1.4.1" +[[PCRE2_jll]] +deps = ["Artifacts", "Libdl"] +uuid = "efcefdf7-47ab-520b-bdef-62a2eaa19f15" +version = "10.40.0+0" + [[PCRE_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] git-tree-sha1 = "b2a7af664e098055a7529ad1a900ded962bca488" @@ -510,9 +518,9 @@ version = "8.44.0+0" [[Parsers]] deps = ["Dates"] -git-tree-sha1 = "0044b23da09b5608b4ecacb4e5e6c6332f833a7e" +git-tree-sha1 = "3d5bf43e3e8b412656404ed9466f1dcbf7c50269" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "2.3.2" +version = "2.4.0" [[Pixman_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -523,6 +531,7 @@ version = "0.40.1+0" [[Pkg]] deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"] uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" +version = "1.8.0" [[PlotThemes]] deps = ["PlotUtils", "Statistics"] @@ -531,16 +540,16 @@ uuid = "ccf2f8ad-2431-5c83-bf29-c5338b663b6a" version = "3.0.0" [[PlotUtils]] -deps = ["ColorSchemes", "Colors", "Dates", "Printf", "Random", "Reexport", "Statistics"] -git-tree-sha1 = "9888e59493658e476d3073f1ce24348bdc086660" +deps = ["ColorSchemes", "Colors", "Dates", "Printf", "Random", "Reexport", "SnoopPrecompile", "Statistics"] +git-tree-sha1 = "21303256d239f6b484977314674aef4bb1fe4420" uuid = "995b91a9-d308-5afd-9ec6-746e21dbc043" -version = "1.3.0" +version = "1.3.1" [[Plots]] -deps = ["Base64", "Contour", "Dates", "Downloads", "FFMPEG", "FixedPointNumbers", "GR", "GeometryBasics", "JSON", "Latexify", "LinearAlgebra", "Measures", "NaNMath", "Pkg", "PlotThemes", "PlotUtils", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs", "UnicodeFun", "Unzip"] -git-tree-sha1 = "5a1e85f3aed2e0d3d99a4068037c8582597b89cf" +deps = ["Base64", "Contour", "Dates", "Downloads", "FFMPEG", "FixedPointNumbers", "GR", "JSON", "LaTeXStrings", "Latexify", "LinearAlgebra", "Measures", "NaNMath", "Pkg", "PlotThemes", "PlotUtils", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "RelocatableFolders", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs", "UnicodeFun", "Unzip"] +git-tree-sha1 = "6062b3b25ad3c58e817df0747fc51518b9110e5f" uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" -version = "1.31.3" +version = "1.33.0" [[Preferences]] deps = ["TOML"] @@ -573,9 +582,9 @@ version = "1.2.1" [[RecipesPipeline]] deps = ["Dates", "NaNMath", "PlotUtils", "RecipesBase"] -git-tree-sha1 = "2690681814016887462cf5ac37102b51cd9ec781" +git-tree-sha1 = "e7eac76a958f8664f2718508435d058168c7953d" uuid = "01d81517-befc-4cb6-b9ec-a95719d0359c" -version = "0.6.2" +version = "0.6.3" [[Reexport]] git-tree-sha1 = "45e428421666073eab6f2da5c9d310d99bb12f9b" @@ -596,6 +605,7 @@ version = "1.3.0" [[SHA]] uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" +version = "0.7.0" [[Scratch]] deps = ["Dates"] @@ -617,6 +627,11 @@ git-tree-sha1 = "874e8867b33a00e784c8a7e4b60afe9e037b74e1" uuid = "777ac1f9-54b0-4bf8-805c-2214025038e7" version = "1.1.0" +[[SnoopPrecompile]] +git-tree-sha1 = "f604441450a3c0569830946e5b33b78c928e1a85" +uuid = "66db9d55-30c0-4569-8b51-7e840670fc0c" +version = "1.0.1" + [[Sockets]] uuid = "6462fe0b-24de-5631-8697-dd941f90decc" @@ -636,58 +651,31 @@ git-tree-sha1 = "d75bda01f8c31ebb72df80a46c88b25d1c79c56d" uuid = "276daf66-3868-5448-9aa4-cd146d93841b" version = "2.1.7" -[[StaticArrays]] -deps = ["LinearAlgebra", "Random", "StaticArraysCore", "Statistics"] -git-tree-sha1 = "23368a3313d12a2326ad0035f0db0c0966f438ef" -uuid = "90137ffa-7385-5640-81b9-e52037218182" -version = "1.5.2" - -[[StaticArraysCore]] -git-tree-sha1 = "66fe9eb253f910fe8cf161953880cfdaef01cdf0" -uuid = "1e83bf80-4336-4d27-bf5d-d5a4f845583c" -version = "1.0.1" - [[Statistics]] deps = ["LinearAlgebra", "SparseArrays"] uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" [[StatsAPI]] deps = ["LinearAlgebra"] -git-tree-sha1 = "2c11d7290036fe7aac9038ff312d3b3a2a5bf89e" +git-tree-sha1 = "f9af7f195fb13589dd2e2d57fdb401717d2eb1f6" uuid = "82ae8749-77ed-4fe6-ae5f-f523153014b0" -version = "1.4.0" +version = "1.5.0" [[StatsBase]] deps = ["DataAPI", "DataStructures", "LinearAlgebra", "LogExpFunctions", "Missings", "Printf", "Random", "SortingAlgorithms", "SparseArrays", "Statistics", "StatsAPI"] -git-tree-sha1 = "472d044a1c8df2b062b23f222573ad6837a615ba" +git-tree-sha1 = "d1bf48bfcc554a3761a133fe3a9bb01488e06916" uuid = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91" -version = "0.33.19" - -[[StructArrays]] -deps = ["Adapt", "DataAPI", "StaticArrays", "Tables"] -git-tree-sha1 = "ec47fb6069c57f1cee2f67541bf8f23415146de7" -uuid = "09ab397b-f2b6-538f-b94a-2f83cf4a842a" -version = "0.6.11" +version = "0.33.21" [[TOML]] deps = ["Dates"] uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76" - -[[TableTraits]] -deps = ["IteratorInterfaceExtensions"] -git-tree-sha1 = "c06b2f539df1c6efa794486abfb6ed2022561a39" -uuid = "3783bdb8-4a98-5b6b-af9a-565f29a5fe9c" -version = "1.0.1" - -[[Tables]] -deps = ["DataAPI", "DataValueInterfaces", "IteratorInterfaceExtensions", "LinearAlgebra", "OrderedCollections", "TableTraits", "Test"] -git-tree-sha1 = "5ce79ce186cc678bbb5c5681ca3379d1ddae11a1" -uuid = "bd369af6-aec1-5ad0-b16a-f7cc5008161c" -version = "1.7.0" +version = "1.0.0" [[Tar]] deps = ["ArgTools", "SHA"] uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e" +version = "1.10.0" [[TensorCore]] deps = ["LinearAlgebra"] @@ -701,9 +689,9 @@ uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" [[TranscodingStreams]] deps = ["Random", "Test"] -git-tree-sha1 = "216b95ea110b5972db65aa90f88d8d89dcb8851c" +git-tree-sha1 = "8a75929dcd3c38611db2f8d08546decb514fcadf" uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa" -version = "0.9.6" +version = "0.9.9" [[URIs]] git-tree-sha1 = "e59ecc5a41b000fa94423a578d29290c7266fc10" @@ -724,9 +712,9 @@ uuid = "1cfade01-22cf-5700-b092-accc4b62d6e1" version = "0.4.1" [[Unzip]] -git-tree-sha1 = "34db80951901073501137bdbc3d5a8e7bbd06670" +git-tree-sha1 = "ca0969166a028236229f63514992fc073799bb78" uuid = "41fe7b60-77ed-43a1-b4f0-825fd5a5650d" -version = "0.1.2" +version = "0.2.0" [[Wayland_jll]] deps = ["Artifacts", "Expat_jll", "JLLWrappers", "Libdl", "Libffi_jll", "Pkg", "XML2_jll"] @@ -881,6 +869,7 @@ version = "1.4.0+3" [[Zlib_jll]] deps = ["Libdl"] uuid = "83775a58-1f1d-513f-b197-d71354ab007a" +version = "1.2.12+3" [[Zstd_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -903,6 +892,7 @@ version = "0.15.1+0" [[libblastrampoline_jll]] deps = ["Artifacts", "Libdl", "OpenBLAS_jll"] uuid = "8e850b90-86db-534c-a0d3-1478176c7d93" +version = "5.1.1+0" [[libfdk_aac_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -925,10 +915,12 @@ version = "1.3.7+1" [[nghttp2_jll]] deps = ["Artifacts", "Libdl"] uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d" +version = "1.48.0+0" [[p7zip_jll]] deps = ["Artifacts", "Libdl"] uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0" +version = "17.4.0+0" [[x264_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -944,6 +936,6 @@ version = "3.5.0+0" [[xkbcommon_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg", "Wayland_jll", "Wayland_protocols_jll", "Xorg_libxcb_jll", "Xorg_xkeyboard_config_jll"] -git-tree-sha1 = "ece2350174195bb31de1a63bea3a41ae1aa593b6" +git-tree-sha1 = "9ebfc140cc56e8c2156a15ceac2f0302e327ac0a" uuid = "d8fb68d0-12a3-5cfd-a85a-d49703b185fd" -version = "0.9.1+5" +version = "1.4.1+0" diff --git a/docs/src/fileformat.md b/docs/src/fileformat.md index 843409f..9283853 100644 --- a/docs/src/fileformat.md +++ b/docs/src/fileformat.md @@ -3,7 +3,7 @@ The source file format for Literate is a regular, commented, julia (`.jl`) scripts. The idea is that the scripts also serve as documentation on their own and it is also simple to include them in the test-suite, with e.g. `include`, to make sure the examples -stay up do date with other changes in your package. +stay up to date with other changes in your package. ## [**2.1.** Syntax](@id Syntax) diff --git a/docs/src/tips.md b/docs/src/tips.md index bf2495a..846204c 100644 --- a/docs/src/tips.md +++ b/docs/src/tips.md @@ -40,6 +40,16 @@ HTML formats. img = DisplayAs.Text(DisplayAs.PNG(img)) ``` +### [Printing tables in Markdown](@id printing-tables-in-markdown) + +Tables that support the [Tables.jl](https://tables.juliadata.org/) interface can be included in Markdown output with the lightweight package [MarkdownTables.jl](https://github.com/tpapp/MarkdownTables.jl). + +```julia +using MarkdownTables +table = [(a = 1, b = 2), (a = 3, b = 4)] +table |> markdown_table() +``` + ### [Adding admonitions using compound line filtering](@id admonitions-md) Admonitions are a useful feature for drawing attention to particular elements of diff --git a/examples/README.jl b/examples/README.jl index d0966c8..f4e9b2d 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -22,6 +22,12 @@ using Literate Literate.markdown("examples/README.jl", "."; flavor=Literate.CommonMarkFlavor()) + +# ### Related packages +# +# - [Weave.jl](https://github.com/JunoLab/Weave.jl) + + # [docs-img]: https://img.shields.io/badge/docs-latest%20release-blue.svg # [docs-url]: https://fredrikekre.github.io/Literate.jl/ # diff --git a/src/Literate.jl b/src/Literate.jl index 440b748..a931e64 100644 --- a/src/Literate.jl +++ b/src/Literate.jl @@ -566,8 +566,7 @@ function markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwarg # create the markdown file sb = sandbox() iomd = IOBuffer() - continued = false - for chunk in chunks + for (chunknum, chunk) in enumerate(chunks) if isa(chunk, MDChunk) for line in chunk.lines write(iomd, line.second, '\n') # skip indent here @@ -600,7 +599,9 @@ function markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwarg inputfile=config["literate_inputfile"], fake_source=config["literate_outputfile"], flavor=config["flavor"], - image_formats=config["image_formats"]) + image_formats=config["image_formats"], + file_prefix="$(config["name"])-$(chunknum)", + ) end end end @@ -617,7 +618,7 @@ end function execute_markdown!(io::IO, sb::Module, block::String, outputdir; inputfile::String, fake_source::String, - flavor::AbstractFlavor, image_formats::Vector) + flavor::AbstractFlavor, image_formats::Vector, file_prefix::String) # TODO: Deal with explicit display(...) calls r, str, _ = execute_block(sb, block; inputfile=inputfile, fake_source=fake_source) # issue #101: consecutive codefenced blocks need newline @@ -634,7 +635,7 @@ function execute_markdown!(io::IO, sb::Module, block::String, outputdir; end for (mime, ext) in image_formats if Base.invokelatest(showable, mime, r) - file = string(hash(block) % UInt32) * ext + file = file_prefix * ext open(joinpath(outputdir, file), "w") do io Base.invokelatest(show, io, mime, r) end diff --git a/test/runtests.jl b/test/runtests.jl index f8fc514..73312f7 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -293,6 +293,7 @@ const GITLAB_ENV = Dict( (k => nothing for k in keys(TRAVIS_ENV))..., (k => nothing for k in keys(ACTIONS_ENV))..., ) + @testset "Literate.script" begin; Base.CoreLogging.with_logger(Base.CoreLogging.NullLogger()) do mktempdir(@__DIR__) do sandbox cd(sandbox) do @@ -850,9 +851,9 @@ end end markdown = read(joinpath(outdir, "inputfile.md"), String) @test occursin("```\n2\n```", markdown) # text/plain @test occursin("```\n2×2 $(Matrix{Int}):\n 1 2\n 3 4\n```", markdown) # text/plain - @test occursin(r"!\[\]\(\d+\.png\)", markdown) # image/png - @test occursin(r"!\[\]\(\d+\.jpeg\)", markdown) # image/jpeg - @test occursin(r"!\[\]\(\d+\.svg\)", markdown) # image/svg+xml, fredrikekre/Literate.jl#182 + @test occursin(r"!\[\]\(inputfile-5\.png\)", markdown) # image/png + @test occursin(r"!\[\]\(inputfile-6\.jpeg\)", markdown) # image/jpeg + @test occursin(r"!\[\]\(inputfile-7\.svg\)", markdown) # image/svg+xml, fredrikekre/Literate.jl#182 @test occursin("# MD", markdown) # text/markdown @test occursin("```@raw html\n

MD

\n```", markdown) # text/html @test occursin("```\nPlain\n```", markdown) # text/plain, fredrikekre/Literate#187