From 95131f8ebab6af9586a78b1cb4809dba9f2bf9e2 Mon Sep 17 00:00:00 2001 From: Sukera <11753998+Seelengrab@users.noreply.github.com> Date: Fri, 22 Mar 2024 01:06:32 +0100 Subject: [PATCH] Update Documenter version for doc building (#339) Co-authored-by: Sukera --- docs/.gitignore | 1 + docs/Manifest.toml | 93 ---------------------------------------------- docs/Project.toml | 3 +- docs/make.jl | 23 +++++++++--- docs/src/index.md | 2 +- 5 files changed, 21 insertions(+), 101 deletions(-) create mode 100644 docs/.gitignore delete mode 100644 docs/Manifest.toml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..ba39cc5 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +Manifest.toml diff --git a/docs/Manifest.toml b/docs/Manifest.toml deleted file mode 100644 index 485804e..0000000 --- a/docs/Manifest.toml +++ /dev/null @@ -1,93 +0,0 @@ -# This file is machine-generated - editing it directly is not advised - -[[Base64]] -uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" - -[[Dates]] -deps = ["Printf"] -uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" - -[[Distributed]] -deps = ["Random", "Serialization", "Sockets"] -uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" - -[[DocStringExtensions]] -deps = ["LibGit2", "Markdown", "Pkg", "Test"] -git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a" -uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.8.1" - -[[Documenter]] -deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] -git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c" -uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "0.23.4" - -[[InteractiveUtils]] -deps = ["Markdown"] -uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" - -[[JSON]] -deps = ["Dates", "Mmap", "Parsers", "Unicode"] -git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e" -uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" -version = "0.21.0" - -[[LibGit2]] -deps = ["Printf"] -uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" - -[[Libdl]] -uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" - -[[Logging]] -uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" - -[[Markdown]] -deps = ["Base64"] -uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" - -[[Mmap]] -uuid = "a63ad114-7e13-5084-954f-fe012c677804" - -[[Parsers]] -deps = ["Dates", "Test"] -git-tree-sha1 = "c56ecb484f286639f161e712b8311f5ab77e8d32" -uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "0.3.8" - -[[Pkg]] -deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] -uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" - -[[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" - -[[SHA]] -uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" - -[[Serialization]] -uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" - -[[Sockets]] -uuid = "6462fe0b-24de-5631-8697-dd941f90decc" - -[[Test]] -deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] -uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" - -[[UUIDs]] -deps = ["Random", "SHA"] -uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" - -[[Unicode]] -uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" diff --git a/docs/Project.toml b/docs/Project.toml index 58f159c..d339c28 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,6 +1,7 @@ [deps] +DBInterface = "a10d1c49-ce27-4219-8d33-6db1a4562965" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" SQLite = "0aa819cd-b072-5ff4-a722-6bc24af294d9" [compat] -Documenter = "~0.26.1" +Documenter = "1.3" diff --git a/docs/make.jl b/docs/make.jl index a992771..5f46c2c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,13 +1,24 @@ -using Documenter, SQLite +import Pkg + +cd(@__DIR__) +Pkg.activate(@__DIR__) +Pkg.develop(path="..") +Pkg.instantiate() + +using Documenter, SQLite, DBInterface + +DocMeta.setdocmeta!(SQLite, :DocTestSetup, :(using SQLite, DBInterface); recursive=true) makedocs(; - modules = [SQLite], - format = Documenter.HTML(), + format = Documenter.HTML( + prettyurls = get(ENV, "CI", nothing) == true, + ), pages = ["Home" => "index.md"], - repo = "https://github.com/JuliaDatabases/SQLite.jl/blob/{commit}{path}#L{line}", + repo = Remotes.GitHub("JuliaDatabases", "SQLite.jl"), sitename = "SQLite.jl", authors = "Jacob Quinn", - assets = String[], ) -deploydocs(; repo = "github.com/JuliaDatabases/SQLite.jl") +deploydocs( + repo = "https://www.github.com/JuliaDatabases/SQLite.jl.git", +) diff --git a/docs/src/index.md b/docs/src/index.md index 3371ab0..061adf0 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,7 +5,7 @@ ## High-level interface ```@docs -DBInterface.execute +DBInterface.execute(::SQLite.Stmt, ::DBInterface.StatementParams) SQLite.load! ```