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

[new release] odoc and odoc-parser (2.4.0) #24930

Merged
merged 4 commits into from
Dec 14, 2023
Merged

Conversation

Julow
Copy link
Contributor

@Julow Julow commented Dec 12, 2023

OCaml Documentation Generator

CHANGES:

Added

Fixed

Changed

@Julow Julow force-pushed the release-odoc-2.4.0 branch from c486f20 to 8f196bb Compare December 12, 2023 11:16
@Julow
Copy link
Contributor Author

Julow commented Dec 12, 2023

Odoc's tests are not passing on < 4.10 and on macos. Is it reasonable to disable the tests for these versions ? Otherwise a patch is available at ocaml/odoc#1061

@Julow
Copy link
Contributor Author

Julow commented Dec 12, 2023

Instead, I chose to redo the release.

CHANGES:

### Added

- Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972)
  This includes the generation of an index and the display of the results in
  the UI (HTML only).

- Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019)
- Allow to omit parent type in constructor reference (@panglesd,
  @EmileTrotignon, ocaml/odoc#933)

### Fixed

- Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050)
- Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050)
- Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046)
- Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971)
- Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949)

### Changed

- Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045)
- Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028)
- Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967)
- Style: Sidebar is now stuck to the left of the content instead of the left of
  the viewport (@EmileTrotignon, ocaml/odoc#999)
@Julow Julow force-pushed the release-odoc-2.4.0 branch from c822197 to 9d05353 Compare December 12, 2023 14:36
@Julow
Copy link
Contributor Author

Julow commented Dec 14, 2023

The CI reports a problem with lower bounds on 4.03 but I think it's a problem with crunch's lower bounds. The same test passes in 4.02 and all the other versions.

@mseri
Copy link
Member

mseri commented Dec 14, 2023

The lower bounds issue is unrelated

@mseri mseri merged commit 7dc3316 into ocaml:master Dec 14, 2023
1 of 2 checks passed
@mseri
Copy link
Member

mseri commented Dec 14, 2023

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants