From b8c7d03b38ab99d3e9510bcc9e30f9c11cdeebb2 Mon Sep 17 00:00:00 2001 From: Jean-Francois Baffier Date: Thu, 30 May 2024 16:10:33 +0900 Subject: [PATCH] Clean doc and related CI (#22) --- .github/workflows/CI.yml | 46 ++++++++--------- docs/Manifest.toml | 103 --------------------------------------- docs/Project.toml | 3 -- docs/make.jl | 25 ---------- docs/src/index.md | 14 ------ 5 files changed, 23 insertions(+), 168 deletions(-) delete mode 100644 docs/Manifest.toml delete mode 100644 docs/Project.toml delete mode 100644 docs/make.jl delete mode 100644 docs/src/index.md diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index e8d95db..92b950d 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -91,26 +91,26 @@ jobs: - uses: codecov/codecov-action@v4 with: file: lcov.info - docs: - name: Documentation - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: julia-actions/setup-julia@v1 - with: - version: "1" - - run: | - julia --project=docs -e ' - using Pkg - Pkg.develop(PackageSpec(path=pwd())) - Pkg.instantiate()' - - run: | - julia --project=docs -e ' - using Documenter: DocMeta, doctest - using ConstraintCommons - DocMeta.setdocmeta!(ConstraintCommons, :DocTestSetup, :(using ConstraintCommons); recursive=true) - doctest(ConstraintCommons)' - - run: julia --project=docs docs/make.jl - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} + # docs: + # name: Documentation + # runs-on: ubuntu-latest + # steps: + # - uses: actions/checkout@v4 + # - uses: julia-actions/setup-julia@v1 + # with: + # version: "1" + # - run: | + # julia --project=docs -e ' + # using Pkg + # Pkg.develop(PackageSpec(path=pwd())) + # Pkg.instantiate()' + # - run: | + # julia --project=docs -e ' + # using Documenter: DocMeta, doctest + # using ConstraintCommons + # DocMeta.setdocmeta!(ConstraintCommons, :DocTestSetup, :(using ConstraintCommons); recursive=true) + # doctest(ConstraintCommons)' + # - run: julia --project=docs docs/make.jl + # env: + # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} diff --git a/docs/Manifest.toml b/docs/Manifest.toml deleted file mode 100644 index 53f5538..0000000 --- a/docs/Manifest.toml +++ /dev/null @@ -1,103 +0,0 @@ -# This file is machine-generated - editing it directly is not advised - -julia_version = "1.8.2" -manifest_format = "2.0" -project_hash = "7a85304a37bb7b02f08f962cc0ef12adebf44815" - -[[deps.ANSIColoredPrinters]] -git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" -uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9" -version = "0.0.1" - -[[deps.Base64]] -uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" - -[[deps.ConstraintCommons]] -path = ".." -uuid = "e37357d9-0691-492f-a822-e5ea6a920954" -version = "0.1.0" - -[[deps.Dates]] -deps = ["Printf"] -uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" - -[[deps.DocStringExtensions]] -deps = ["LibGit2"] -git-tree-sha1 = "c36550cb29cbe373e95b3f40486b9a4148f89ffd" -uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.9.2" - -[[deps.Documenter]] -deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] -git-tree-sha1 = "6030186b00a38e9d0434518627426570aac2ef95" -uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "0.27.23" - -[[deps.IOCapture]] -deps = ["Logging", "Random"] -git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a" -uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89" -version = "0.2.2" - -[[deps.InteractiveUtils]] -deps = ["Markdown"] -uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" - -[[deps.JSON]] -deps = ["Dates", "Mmap", "Parsers", "Unicode"] -git-tree-sha1 = "3c837543ddb02250ef42f4738347454f95079d4e" -uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" -version = "0.21.3" - -[[deps.LibGit2]] -deps = ["Base64", "NetworkOptions", "Printf", "SHA"] -uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" - -[[deps.Logging]] -uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" - -[[deps.Markdown]] -deps = ["Base64"] -uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" - -[[deps.Mmap]] -uuid = "a63ad114-7e13-5084-954f-fe012c677804" - -[[deps.NetworkOptions]] -uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" -version = "1.2.0" - -[[deps.Parsers]] -deps = ["Dates"] -git-tree-sha1 = "6c01a9b494f6d2a9fc180a08b182fcb06f0958a0" -uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "2.4.2" - -[[deps.Printf]] -deps = ["Unicode"] -uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" - -[[deps.REPL]] -deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"] -uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" - -[[deps.Random]] -deps = ["SHA", "Serialization"] -uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" - -[[deps.SHA]] -uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" -version = "0.7.0" - -[[deps.Serialization]] -uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" - -[[deps.Sockets]] -uuid = "6462fe0b-24de-5631-8697-dd941f90decc" - -[[deps.Test]] -deps = ["InteractiveUtils", "Logging", "Random", "Serialization"] -uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" - -[[deps.Unicode]] -uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" diff --git a/docs/Project.toml b/docs/Project.toml deleted file mode 100644 index 1122b1e..0000000 --- a/docs/Project.toml +++ /dev/null @@ -1,3 +0,0 @@ -[deps] -ConstraintCommons = "e37357d9-0691-492f-a822-e5ea6a920954" -Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl deleted file mode 100644 index 5cf208e..0000000 --- a/docs/make.jl +++ /dev/null @@ -1,25 +0,0 @@ -using ConstraintCommons -using Documenter - -DocMeta.setdocmeta!( - ConstraintCommons, - :DocTestSetup, - :(using ConstraintCommons); - recursive = true, -) - -makedocs(; - modules = [ConstraintCommons], - authors = "azzaare (jean-François BAFFIER)", - repo = "https://github.com/JuliaConstraints/ConstraintCommons.jl/blob/{commit}{path}#{line}", - sitename = "ConstraintCommons.jl", - format = Documenter.HTML(; - prettyurls = get(ENV, "CI", "false") == "true", - canonical = "https://JuliaConstraints.github.io/ConstraintCommons.jl", - edit_link = "main", - assets = String[], - ), - pages = ["Home" => "index.md"], -) - -deploydocs(; repo = "github.com/JuliaConstraints/ConstraintCommons.jl", devbranch = "main") diff --git a/docs/src/index.md b/docs/src/index.md deleted file mode 100644 index 15d761a..0000000 --- a/docs/src/index.md +++ /dev/null @@ -1,14 +0,0 @@ -```@meta -CurrentModule = ConstraintCommons -``` - -# ConstraintCommons - -Documentation for [ConstraintCommons](https://github.com/JuliaConstraints/ConstraintCommons.jl). - -```@index -``` - -```@autodocs -Modules = [ConstraintCommons] -```