Skip to content

Commit 2325b5d

Browse files
authored
changelog: add missing odoc releases (#3248)
1 parent ae568d6 commit 2325b5d

4 files changed

Lines changed: 144 additions & 1 deletion

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Odoc 2.4.3
3+
tags:
4+
- odoc
5+
- platform
6+
authors:
7+
contributors:
8+
changelog: |
9+
### Fixed
10+
11+
* Fix missing katex headers ([@panglesd](https://github.com/panglesd), [#1096](https://github.com/ocaml/odoc/pull/1096))
12+
* Allow `][` in code blocks, fixing issue [#1137](https://github.com/ocaml/odoc/issues/1137) ([@Julow](https://github.com/Julow), [#1149](https://github.com/ocaml/odoc/pull/1149))
13+
This was interpreted as "code blocks with result", which now mandates a
14+
delimiter: `{delim@lang[ code ]delim[ result ]}`
15+
* Fix misprinting of type variables from ml files for OCaml 4.14 and later
16+
(multiple occurences of the same type variable could be named differently)
17+
([@Octachron](https://github.com/Octachron), [#1173](https://github.com/ocaml/odoc/pull/1173))
18+
versions:
19+
unstable: false
20+
ignore: false
21+
github_release_tags:
22+
- 2.4.3
23+
---
24+
25+
We're happy to announce the release of Odoc 2.4.3!
26+
27+
This release includes three key fixes: we restored missing KaTeX headers for proper mathematical rendering, resolved an issue where `][` characters in code blocks were incorrectly interpreted as "code blocks with result" (now requiring explicit delimiters), and corrected the misprinting of type variables from ML files in OCaml 4.14 and later versions where multiple instances of the same type variable could be displayed with different names.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Odoc 2.4.4
3+
tags:
4+
- odoc
5+
- platform
6+
authors:
7+
contributors:
8+
changelog: |
9+
### Added
10+
11+
* OCaml 5.3.0 compatibility ([@Julow](https://github.com/Julow), [#1202](https://github.com/ocaml/odoc/pull/1202), [#1254](https://github.com/ocaml/odoc/pull/1254))
12+
versions:
13+
unstable: false
14+
ignore: false
15+
github_release_tags:
16+
- 2.4.4
17+
---
18+
19+
We're happy to announce the release of Odoc 2.4.4 which brings compatibility with OCaml 5.3!

data/changelog/releases/odoc/2025-03-20-odoc-3.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Odoc 3.0
2+
title: Odoc 3.0.0
33
tags: [odoc, platform]
44
github_release_tags: [3.0.0]
55
changelog: |
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Odoc 3.1.0
3+
tags:
4+
- odoc
5+
- platform
6+
authors:
7+
contributors:
8+
changelog: |
9+
### Added
10+
11+
* Exposed sherlodoc libraries for use in other projects ([@jonludlam](https://github.com/jonludlam), [#1349](https://github.com/ocaml/odoc/pull/1349))
12+
* OCaml 5.4.0 support ([@Octachron](https://github.com/Octachron), [#1355](https://github.com/ocaml/odoc/pull/1355))
13+
* New arguments to LaTeX generator, --shorten-beyond-depth and
14+
\--remove-functor-arg-link ([@Octachron](https://github.com/Octachron), [#1337](https://github.com/ocaml/odoc/pull/1337))
15+
* New experimental markdown generator ([@davesnx](https://github.com/davesnx), [#1341](https://github.com/ocaml/odoc/pull/1341))
16+
17+
### Changed
18+
19+
* Remove cmdliner compatibility layer, no longer needed ([@dbuenzli](https://github.com/dbuenzli), [#1328](https://github.com/ocaml/odoc/pull/1328))
20+
* Drop support for OCaml < 4.08 ([@jonludlam](https://github.com/jonludlam), [#1300](https://github.com/ocaml/odoc/pull/1300))
21+
* Allow referencing libraries from package added in `odoc-config.sexp`
22+
([@panglesd](https://github.com/panglesd), [#1343](https://github.com/ocaml/odoc/pull/1343))
23+
* Use full path in heading labels in LaTeX backend ([@Octachron](https://github.com/Octachron), [#1332](https://github.com/ocaml/odoc/pull/1332))
24+
* Separate page from anchor in LaTeX labels to prevent collisions ([@Octachron](https://github.com/Octachron),
25+
[#1337](https://github.com/ocaml/odoc/pull/1337))
26+
27+
### Fixed
28+
29+
* Fix bug in parsing META files when there are no dependencies ([@jonludlam](https://github.com/jonludlam), [#1352](https://github.com/ocaml/odoc/pull/1352))
30+
* Fix [#1335](https://github.com/ocaml/odoc/issues/1335) - incorrect rendering when on medium screen size with no global
31+
sidebar ([@lukemaurer](https://github.com/lukemaurer), [#1361](https://github.com/ocaml/odoc/pull/1361))
32+
* Fixed generation of occurrences for docs CI ([@jonludlam](https://github.com/jonludlam), [#1362](https://github.com/ocaml/odoc/pull/1362))
33+
* Partial fix for [#1369](https://github.com/ocaml/odoc/issues/1369) - ensure that we never create a link to a hidden page
34+
([@jonludlam](https://github.com/jonludlam), [#1370](https://github.com/ocaml/odoc/pull/1370))
35+
versions:
36+
unstable: false
37+
ignore: false
38+
github_release_tags:
39+
- 3.1.0
40+
---
41+
42+
We're excited to announce the release of odoc 3.1.0! This release brings several new features, important improvements, and bug fixes to OCaml's documentation generator.
43+
44+
## What's New
45+
46+
### OCaml 5.4.0 Compatibility
47+
Full support for OCaml 5.4.0 has been added, ensuring odoc stays current with the latest OCaml releases.
48+
49+
### New Output Formats and Options
50+
- **Enhanced LaTeX Generator**: New command-line arguments `--shorten-beyond-depth` and `--remove-functor-arg-link` provide more control over LaTeX output formatting
51+
52+
## Key Improvements
53+
54+
### Modernized Dependencies
55+
The cmdliner compatibility layer has been removed as it's no longer needed, simplifying the codebase and reducing maintenance overhead.
56+
57+
### Updated System Requirements
58+
Support for OCaml versions prior to 4.08 has been dropped, allowing the project to leverage more modern language features and reduce compatibility complexity.
59+
60+
### Better Configuration Management
61+
Libraries from packages can now be referenced when added in `odoc-config.sexp`, improving flexibility in documentation project setup.
62+
63+
### Improved LaTeX Output
64+
- Heading labels now use full paths to improve navigation and reference accuracy
65+
- Page and anchor separation in LaTeX labels prevents naming collisions
66+
67+
## Bug Fixes
68+
69+
This release addresses several important issues:
70+
- Fixed META file parsing when dependencies are absent
71+
- Resolved rendering problems on medium screen sizes without global sidebar
72+
- Corrected occurrence generation for documentation CI systems
73+
- Ensured hidden pages never receive links, preventing broken references
74+
75+
## Getting Started
76+
77+
To install odoc 3.1.0:
78+
79+
```bash
80+
opam install odoc
81+
```
82+
83+
For existing users, upgrade with:
84+
85+
```bash
86+
opam upgrade odoc
87+
```
88+
89+
## Contributors
90+
91+
Special thanks to all contributors who made this release possible: [@jonludlam](https://github.com/jonludlam), [@Octachron](https://github.com/Octachron), [@davesnx](https://github.com/davesnx), [@dbuenzli](https://github.com/dbuenzli), [@panglesd](https://github.com/panglesd), and [@lukemaurer](https://github.com/lukemaurer).
92+
93+
## What's Next
94+
95+
We continue to work on expanding odoc's capabilities and improving documentation generation. The development team remains committed to making OCaml documentation more accessible and comprehensive.
96+
97+
Happy documenting!

0 commit comments

Comments
 (0)