From d43e75a69e49a7def6f9059d14f83bd442f00d7b Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Thu, 23 Aug 2018 09:44:40 +0200 Subject: [PATCH] Use a doc project for documentation building --- .travis.yml | 3 +- docs/Manifest.toml | 230 +++++++++++++++++++++++++++++++++++++++++++++ docs/Project.toml | 4 + docs/make.jl | 11 +-- 4 files changed, 241 insertions(+), 7 deletions(-) create mode 100644 docs/Manifest.toml create mode 100644 docs/Project.toml diff --git a/.travis.yml b/.travis.yml index a9a3ba5..6011f82 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,7 +19,8 @@ jobs: julia: 1.0 os: linux script: - - julia docs/make.jl + - julia --project=docs -e 'using Pkg; Pkg.instantiate()' + - julia --project=docs --color=yes docs/make.jl - julia --project=test/coverage -e 'using Pkg; Pkg.instantiate()' - julia --project=test/coverage test/coverage/coverage.jl notifications: diff --git a/docs/Manifest.toml b/docs/Manifest.toml new file mode 100644 index 0000000..3ea627c --- /dev/null +++ b/docs/Manifest.toml @@ -0,0 +1,230 @@ +[[Base64]] +uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" + +[[ColorTypes]] +deps = ["FixedPointNumbers", "Random", "Test"] +git-tree-sha1 = "0e3209ba7418aed732e5c3818076b4400ee36c08" +uuid = "3da002f7-5984-5a60-b8a6-cbb66c0b333f" +version = "0.7.4" + +[[Colors]] +deps = ["ColorTypes", "FixedPointNumbers", "InteractiveUtils", "Pkg", "Printf", "Reexport", "Test"] +git-tree-sha1 = "26f24e97782dd19d52cf97073c316897ac4d0e30" +uuid = "5ae59095-9a9b-59fe-a467-6f913c188581" +version = "0.9.3" + +[[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 = "277d3807440d9793421354b6680911fc95d91a84" +uuid = "34da2185-b29b-5c13-b0c7-acf172513d20" +version = "1.0.1" + +[[Contour]] +deps = ["LinearAlgebra", "StaticArrays", "Test"] +git-tree-sha1 = "b974e164358fea753ef853ce7bad97afec15bb80" +uuid = "d38c429a-6771-53c6-b99e-75d170b6e991" +version = "0.5.1" + +[[DataStructures]] +deps = ["InteractiveUtils", "REPL", "Random", "Serialization", "Test"] +git-tree-sha1 = "6e72a9098f5774601c8c8d6a4511a68270594910" +uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" +version = "0.11.0" + +[[Dates]] +deps = ["Printf"] +uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" + +[[DelimitedFiles]] +deps = ["Mmap"] +uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab" + +[[Distributed]] +deps = ["LinearAlgebra", "Random", "Serialization", "Sockets"] +uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" + +[[DocStringExtensions]] +deps = ["Compat"] +git-tree-sha1 = "a2ab006ff561a57eb858cee5314445b16c2fd2dd" +uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" +version = "0.4.6" + +[[Documenter]] +deps = ["Compat", "DocStringExtensions", "Logging", "REPL"] +git-tree-sha1 = "7534ff3c50333a69ae0778d4d869e6f5c9ec022a" +uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +version = "0.19.6" + +[[FixedPointNumbers]] +deps = ["Pkg", "Test"] +git-tree-sha1 = "31cbf24d537a217475b37274df05de09882b53f1" +uuid = "53c48c17-4a7d-5ca2-90c5-79b7896eea93" +version = "0.5.2" + +[[GR]] +deps = ["Base64", "DelimitedFiles", "Random", "Serialization", "Sockets", "Test"] +git-tree-sha1 = "9a56e1f77aba288918200ec6d224b63bc456c8e1" +uuid = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71" +version = "0.32.3" + +[[InteractiveUtils]] +deps = ["LinearAlgebra", "Markdown"] +uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" + +[[JSON]] +deps = ["Dates", "Distributed", "Mmap", "Pkg", "Sockets", "Test", "Unicode"] +git-tree-sha1 = "fec8e4d433072731466d37ed0061b3ba7f70eeb9" +uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" +version = "0.19.0" + +[[LibGit2]] +uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" + +[[Libdl]] +uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" + +[[LinearAlgebra]] +deps = ["Libdl"] +uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" + +[[Literate]] +deps = ["Base64", "JSON", "REPL"] +path = ".." +uuid = "98b081ad-f1c9-55d3-8b20-4c87d4299306" +version = "1.0.1" + +[[Logging]] +uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" + +[[Markdown]] +deps = ["Base64"] +uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" + +[[Measures]] +deps = ["Compat"] +git-tree-sha1 = "9cdd05418a7f2f7ce534014285edf01f465d6961" +uuid = "442fdcdd-2543-5da2-b0f3-8c86c306513e" +version = "0.2.0" + +[[Missings]] +deps = ["Dates", "InteractiveUtils", "SparseArrays", "Test"] +git-tree-sha1 = "196528fa1df03df435025f52f9c1ff8356f94738" +uuid = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28" +version = "0.3.0" + +[[Mmap]] +uuid = "a63ad114-7e13-5084-954f-fe012c677804" + +[[NaNMath]] +deps = ["Compat"] +git-tree-sha1 = "ce3b85e484a5d4c71dd5316215069311135fa9f2" +uuid = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3" +version = "0.3.2" + +[[Pkg]] +deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] +uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" + +[[PlotThemes]] +deps = ["PlotUtils", "Requires", "Test"] +git-tree-sha1 = "f3afd2d58e1f6ac9be2cea46e4a9083ccc1d990b" +uuid = "ccf2f8ad-2431-5c83-bf29-c5338b663b6a" +version = "0.3.0" + +[[PlotUtils]] +deps = ["Colors", "Dates", "Printf", "Random", "Reexport", "Test"] +git-tree-sha1 = "6fd6fafca71798236eccdf5fb1f7e997884e1ad2" +uuid = "995b91a9-d308-5afd-9ec6-746e21dbc043" +version = "0.5.3" + +[[Plots]] +deps = ["Base64", "Contour", "Dates", "FixedPointNumbers", "GR", "JSON", "LinearAlgebra", "Measures", "NaNMath", "Pkg", "PlotThemes", "PlotUtils", "Printf", "REPL", "RecipesBase", "Reexport", "Requires", "Showoff", "SparseArrays", "StaticArrays", "Statistics", "StatsBase", "Test", "UUIDs"] +git-tree-sha1 = "935241178e80158451cc33f4af7c57f671b881b8" +uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" +version = "0.19.3" + +[[Printf]] +deps = ["Unicode"] +uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" + +[[REPL]] +deps = ["InteractiveUtils", "Markdown", "Sockets"] +uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" + +[[Random]] +deps = ["Serialization"] +uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" + +[[RecipesBase]] +deps = ["Pkg", "Random", "Test"] +git-tree-sha1 = "b18c3d875ad6805e3db59c4e81f206f04df71d66" +uuid = "3cdcf5f2-1ef4-517c-9805-6587b60abb01" +version = "0.5.0" + +[[Reexport]] +deps = ["Pkg"] +git-tree-sha1 = "7b1d07f411bc8ddb7977ec7f377b97b158514fe0" +uuid = "189a3867-3050-52da-a836-e630ba90ab69" +version = "0.2.0" + +[[Requires]] +deps = ["Test"] +git-tree-sha1 = "f6fbf4ba64d295e146e49e021207993b6b48c7d1" +uuid = "ae029012-a4dd-5104-9daa-d747884805df" +version = "0.5.2" + +[[SHA]] +uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" + +[[Serialization]] +uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" + +[[SharedArrays]] +deps = ["Distributed", "Mmap", "Random", "Serialization"] +uuid = "1a1011a3-84de-559e-8e89-a11a2f7dc383" + +[[Showoff]] +deps = ["Compat", "Pkg"] +git-tree-sha1 = "276b24f3ace98bec911be7ff2928d497dc759085" +uuid = "992d4aef-0814-514b-bc4d-f2e9a6c4116f" +version = "0.2.1" + +[[Sockets]] +uuid = "6462fe0b-24de-5631-8697-dd941f90decc" + +[[SortingAlgorithms]] +deps = ["DataStructures", "Random", "Test"] +git-tree-sha1 = "03f5898c9959f8115e30bc7226ada7d0df554ddd" +uuid = "a2af1166-a08f-5f64-846c-94a0d3cef48c" +version = "0.3.1" + +[[SparseArrays]] +deps = ["LinearAlgebra", "Random"] +uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" + +[[StaticArrays]] +deps = ["InteractiveUtils", "LinearAlgebra", "Random", "Statistics", "Test"] +git-tree-sha1 = "d432c79bef174a830304f8601427a4357dfdbfb7" +uuid = "90137ffa-7385-5640-81b9-e52037218182" +version = "0.8.3" + +[[Statistics]] +deps = ["LinearAlgebra", "SparseArrays"] +uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" + +[[StatsBase]] +deps = ["DataStructures", "LinearAlgebra", "Missings", "Printf", "Random", "SortingAlgorithms", "SparseArrays", "Statistics", "Test"] +git-tree-sha1 = "723193a13e8078cec6dcd0b8fe245c8bfd81690e" +uuid = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91" +version = "0.25.0" + +[[Test]] +deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] +uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[[UUIDs]] +deps = ["Random"] +uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" + +[[Unicode]] +uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..7416adf --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,4 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" +Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" diff --git a/docs/make.jl b/docs/make.jl index 3a5c080..9d8924c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,12 +1,11 @@ -using Pkg - -pkg""" -add Documenter Plots#master -precompile -""" +if Base.HOME_PROJECT[] !== nothing + # JuliaLang/julia/pull/28625 + Base.HOME_PROJECT[] = abspath(Base.HOME_PROJECT[]) +end using Documenter using Literate +using Plots # to not capture precompilation output # generate examples EXAMPLE = joinpath(@__DIR__, "..", "examples", "example.jl")