From a07ed991d6dac8745ecabb62c78671c7556771c7 Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Thu, 23 Jan 2025 10:58:12 +0000 Subject: [PATCH 1/6] Update CHANGES.md --- CHANGES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index 7a10e98447..794e0258d5 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,4 +1,4 @@ -# (unreleased) +# 3.0.0~beta1 ### Highlight From bec6d81d52533bcbb0821e4776220d2ec1f577cb Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Thu, 23 Jan 2025 11:55:56 +0000 Subject: [PATCH 2/6] Update opam files --- odoc-driver.opam | 4 ++++ odoc-md.opam | 4 ++++ odoc-parser.opam | 3 +++ odoc.opam | 3 +++ sherlodoc.opam | 5 ++++- 5 files changed, 18 insertions(+), 1 deletion(-) diff --git a/odoc-driver.opam b/odoc-driver.opam index 09c6bcce07..98555b3f64 100644 --- a/odoc-driver.opam +++ b/odoc-driver.opam @@ -5,6 +5,7 @@ homepage: "https://github.com/ocaml/odoc" doc: "https://ocaml.github.io/odoc/" bug-reports: "https://github.com/ocaml/odoc/issues" license: "ISC" +flags: [ avoid-version ] maintainer: [ "Daniel Bünzli " @@ -64,3 +65,6 @@ build: [ "@doc" {with-doc} ] ] + +x-maintenance-intent: ["(latest)"] + diff --git a/odoc-md.opam b/odoc-md.opam index 983a497dc1..b4cb587a02 100644 --- a/odoc-md.opam +++ b/odoc-md.opam @@ -5,6 +5,7 @@ homepage: "https://github.com/ocaml/odoc" doc: "https://ocaml.github.io/odoc/" bug-reports: "https://github.com/ocaml/odoc/issues" license: "ISC" +flags: [ avoid-version ] maintainer: [ "Jon Ludlam " @@ -45,3 +46,6 @@ build: [ "@doc" {with-doc} ] ] + +x-maintenance-intent: ["(latest)"] + diff --git a/odoc-parser.opam b/odoc-parser.opam index b167c9a85d..4cbd236094 100644 --- a/odoc-parser.opam +++ b/odoc-parser.opam @@ -12,6 +12,7 @@ homepage: "https://github.com/ocaml/odoc" bug-reports: "https://github.com/ocaml/odoc/issues" dev-repo: "git+https://github.com/ocaml/odoc.git" doc: "https://ocaml.github.io/odoc/odoc_parser" +flags: [ avoid-version ] depends: [ "dune" {>= "3.7"} "ocaml" {>= "4.02.0" & < "5.4"} @@ -36,3 +37,5 @@ build: [ "@src/parser/runtest" {with-test} ] ] +x-maintenance-intent: ["(latest)"] + diff --git a/odoc.opam b/odoc.opam index db12ddc3bb..887b7459b0 100644 --- a/odoc.opam +++ b/odoc.opam @@ -5,6 +5,7 @@ homepage: "https://github.com/ocaml/odoc" doc: "https://ocaml.github.io/odoc/" bug-reports: "https://github.com/ocaml/odoc/issues" license: "ISC" +flags: [ avoid-version ] maintainer: [ "Daniel Bünzli " @@ -82,3 +83,5 @@ build: [ "@doc" {with-doc} ] ] +x-maintenance-intent: ["(latest)"] + diff --git a/sherlodoc.opam b/sherlodoc.opam index c40545fec6..b29abf31cb 100644 --- a/sherlodoc.opam +++ b/sherlodoc.opam @@ -7,10 +7,11 @@ license: "MIT" homepage: "https://github.com/ocaml/odoc" doc: "https://ocaml.github.io/odoc/" bug-reports: "https://github.com/ocaml/odoc/issues" +flags: [ avoid-version ] depends: [ "dune" {>= "3.5"} "ocaml" {>= "4.0.8"} - "odoc" {>= "3.0.0"} + "odoc" {= version} "base64" {>= "3.5.1"} "bigstringaf" {>= "0.9.1"} "js_of_ocaml" {>= "5.6.0"} @@ -45,3 +46,5 @@ build: [ ] ] dev-repo: "git+https://github.com/ocaml/odoc.git" +x-maintenance-intent: ["(latest)"] + From 6cbb5188e720fe1fde24f8182d7bf58f53a8fc27 Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Fri, 24 Jan 2025 12:34:00 +0000 Subject: [PATCH 3/6] Fix opam files following opam-repo ci checks --- odoc-driver.opam | 1 + odoc-md.opam | 2 +- odoc.opam | 4 +++- sherlodoc.opam | 6 +++--- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/odoc-driver.opam b/odoc-driver.opam index 98555b3f64..484a472fcd 100644 --- a/odoc-driver.opam +++ b/odoc-driver.opam @@ -36,6 +36,7 @@ documentation for installed packages. depends: [ "ocaml" {>= "5.1.0"} "odoc" {= version} + "dune" {>= "3.7.0} "odoc-md" "bos" "fpath" diff --git a/odoc-md.opam b/odoc-md.opam index b4cb587a02..d972810064 100644 --- a/odoc-md.opam +++ b/odoc-md.opam @@ -29,6 +29,7 @@ This package provides support for generating documentation from Markdown files. depends: [ "ocaml" {>= "4.14.0"} "odoc" {= version} + "dune" {>= "3.7.0"} "cmarkit" ] @@ -42,7 +43,6 @@ build: [ "-j" jobs "@install" - "@runtest" {with-test} "@doc" {with-doc} ] ] diff --git a/odoc.opam b/odoc.opam index 887b7459b0..cba1d09679 100644 --- a/odoc.opam +++ b/odoc.opam @@ -58,11 +58,13 @@ depends: [ "ppx_expect" {with-test} "bos" {with-test} - "crunch" {> "1.1.0"} + "crunch" {> "2.0.0"} ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"}) ] +conflicts: [ "ocaml-option-bytecode-only" ] + x-extra-doc-deps: [ "odoc-driver" {= version} "sherlodoc" {= version} diff --git a/sherlodoc.opam b/sherlodoc.opam index b29abf31cb..3985bbf3a6 100644 --- a/sherlodoc.opam +++ b/sherlodoc.opam @@ -9,7 +9,7 @@ doc: "https://ocaml.github.io/odoc/" bug-reports: "https://github.com/ocaml/odoc/issues" flags: [ avoid-version ] depends: [ - "dune" {>= "3.5"} + "dune" {>= "3.7"} "ocaml" {>= "4.0.8"} "odoc" {= version} "base64" {>= "3.5.1"} @@ -21,7 +21,7 @@ depends: [ "fpath" {>= "0.7.3"} "lwt" {>= "5.7.0"} "menhir" {>= "20230608"} - "ppx_blob" {>= "0.7.2"} + "ppx_blob" {>= "0.9.0"} "tyxml" {>= "4.6.0"} "result" {>= "1.5"} "odig" {with-test} @@ -41,7 +41,7 @@ build: [ "-j" jobs "@install" - "@runtest" {with-test} + "@sherlodoc/runtest" {with-test} "@doc" {with-doc} ] ] From 5ec811cb2b22f6486d32ac258789ae7b61fda4fd Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Fri, 24 Jan 2025 12:34:15 +0000 Subject: [PATCH 4/6] Add main_index.mld for docs site --- doc/main_index.mld | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/main_index.mld diff --git a/doc/main_index.mld b/doc/main_index.mld new file mode 100644 index 0000000000..7af7ab24e6 --- /dev/null +++ b/doc/main_index.mld @@ -0,0 +1,12 @@ +{0 The odoc suite} + +The odoc distribution contains a set of packages that can be used to build documentation sites +for OCaml projects. The individual projects are as follows: + +- {{!/odoc/page-index}odoc} - the documentation tool itself +- {{!/sherlodoc/page-index}Sherlodoc} - the recommended search tool +- {{!/odoc-driver/page-index}odoc-driver} - a example driver for odoc +- {{!/odoc-parser/page-index}odoc-parser} - a library to parse odoc markup +- {{!/odoc-md/page-index}odoc-md} - a tool to help integrate markdown pages into the odoc world + + From 06261893e75aea21377af698e62022835880df64 Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Fri, 24 Jan 2025 19:28:42 +0000 Subject: [PATCH 5/6] More fixes following ocaml-ci tests --- odoc-driver.opam | 10 +++++----- odoc.opam | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/odoc-driver.opam b/odoc-driver.opam index 484a472fcd..fd41674054 100644 --- a/odoc-driver.opam +++ b/odoc-driver.opam @@ -36,17 +36,18 @@ documentation for installed packages. depends: [ "ocaml" {>= "5.1.0"} "odoc" {= version} - "dune" {>= "3.7.0} + "dune" {>= "3.7.0"} "odoc-md" "bos" "fpath" - "yojson" + "yojson" {>= "2.0.0"} "ocamlfind" - "opam-format" + "opam-format" {>= "2.1.0"} "logs" "eio_main" + "eio" {>= "1.0"} "progress" - "cmdliner" + "cmdliner" {>= "1.1.0"} "sexplib" "ppx_sexp_conv" "sherlodoc" @@ -62,7 +63,6 @@ build: [ "-j" jobs "@install" - "@runtest" {with-test} "@doc" {with-doc} ] ] diff --git a/odoc.opam b/odoc.opam index cba1d09679..818d9764d4 100644 --- a/odoc.opam +++ b/odoc.opam @@ -58,7 +58,7 @@ depends: [ "ppx_expect" {with-test} "bos" {with-test} - "crunch" {> "2.0.0"} + "crunch" {>= "2.0.0"} ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"}) ] From aeb4aa7a610fa935ae77ccc41893b37ca92a4f33 Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Fri, 24 Jan 2025 23:39:14 +0000 Subject: [PATCH 6/6] Lower lower bound for crunch for OCaml 4.02 --- odoc.opam | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/odoc.opam b/odoc.opam index 818d9764d4..949537a40b 100644 --- a/odoc.opam +++ b/odoc.opam @@ -58,7 +58,7 @@ depends: [ "ppx_expect" {with-test} "bos" {with-test} - "crunch" {>= "2.0.0"} + "crunch" {>= "1.4.1"} ("ocaml" {< "4.07.0" & with-test} | "bisect_ppx" {with-test & > "2.5.0"}) ]