Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync with v3 #1293

Merged
merged 6 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (unreleased)
# 3.0.0~beta1

### Highlight

Expand Down
12 changes: 12 additions & 0 deletions doc/main_index.mld
Original file line number Diff line number Diff line change
@@ -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


13 changes: 9 additions & 4 deletions odoc-driver.opam
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"
Expand Down Expand Up @@ -35,16 +36,18 @@ documentation for installed packages.
depends: [
"ocaml" {>= "5.1.0"}
"odoc" {= version}
"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"
Expand All @@ -60,7 +63,9 @@ build: [
"-j"
jobs
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
]

x-maintenance-intent: ["(latest)"]

6 changes: 5 additions & 1 deletion odoc-md.opam
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"
Expand All @@ -28,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"
]

Expand All @@ -41,7 +43,9 @@ build: [
"-j"
jobs
"@install"
"@runtest" {with-test}
"@doc" {with-doc}
]
]

x-maintenance-intent: ["(latest)"]

3 changes: 3 additions & 0 deletions odoc-parser.opam
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand All @@ -36,3 +37,5 @@ build: [
"@src/parser/runtest" {with-test}
]
]
x-maintenance-intent: ["(latest)"]

7 changes: 6 additions & 1 deletion odoc.opam
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"
Expand Down Expand Up @@ -57,11 +58,13 @@ depends: [

"ppx_expect" {with-test}
"bos" {with-test}
"crunch" {> "1.1.0"}
"crunch" {>= "1.4.1"}

("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}
Expand All @@ -82,3 +85,5 @@ build: [
"@doc" {with-doc}
]
]
x-maintenance-intent: ["(latest)"]

11 changes: 7 additions & 4 deletions sherlodoc.opam
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
"dune" {>= "3.7"}
"ocaml" {>= "4.0.8"}
"odoc" {>= "3.0.0"}
"odoc" {= version}
"base64" {>= "3.5.1"}
"bigstringaf" {>= "0.9.1"}
"js_of_ocaml" {>= "5.6.0"}
Expand All @@ -20,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}
Expand All @@ -40,8 +41,10 @@ build: [
"-j"
jobs
"@install"
"@runtest" {with-test}
"@sherlodoc/runtest" {with-test}
"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/ocaml/odoc.git"
x-maintenance-intent: ["(latest)"]

Loading