Prepare for v3.0

Author: jonludlam

CHANGES.md

@@ -1,59 +1,22 @@
-# Unreleased
-
-### Added
-
-- Added support for (local) images in the latex backend (@Octachron, #1297)
-- Added a `header` field to the json output (@panglesd, #1314)
-- Added an `extract-code` subcommand to extract code blocks from mld files
-  (@panglesd, #1326)
-
-### Changed
-
-- Added suport for overriding tmp directories in odoc_driver_monorepo
-  (@jonludlam, #1304)
-- Remove `--suppress-warnings` argument in favour of `--warnings-tag`
-  which is more friendly for caching and voodoo (@jonludlam, #1304)
-- Filter out warnings coming from linking implementations (@jonludlam, #1319)
-- Output warnings coming from the `compile` phase in the driver (@jonludlam, #1323)
-- Changed the rules for code block and verbatim content (@panglesd, #1317)
-- Store raw content in verbatim and code block, and expose a function to process
-  it (@panglesd, #1325)
-
-### Fixed
-
-- Fix bug causing stack overflow in odoc_driver_monorepo (@jonludlam, #1304)
-- Fix backtrace on invalid input in compile-deps (@jonludlam, #1313)
-- Fix bug in our CSS hitting verbatim blocks in tags (@jonludlam, #1312)
-- Fix poor behaviour when running odoc_driver with unknown or missing packages
-  (@jonludlam, #1311)
-- Fix incomplete handling of `--suppress-warnings` (now `--warnings-tag`)
-  (@jonludlam, #1304)
-- Fix bug in odoc_driver_voodoo related to virtual libraries (@jonludlam, #1309)
-- Fix issue #610 where `odoc html-fragment` wasn't rendering headings correctly
-  (@jonludlam, #1306)
-- Fix bug in `odoc classify` when there are archives that can't be co-linked
-  (@jonludlam, #1310)
-
-# 3.0.0~beta1
+# 3.0.0
 
 ### Highlight
 
-- Hierarchical documentation (@jonludlam, @panglesd, @Julow)
-  Pages can now be organized in a directory tree structure.
-  Relative and absolute references are added:
-  `{!./other_page.label}`, `{!//other_page}`.
+- Hierarchical documentation (@jonludlam, @panglesd, @Julow). Pages can now be
+  organized in a directory tree structure. Relative and absolute references
+  are added: `{!./other_page.label}`, `{!//other_page}`.
 
-- Improved sidebar and breadcrumbs navigation (@panglesd, @gpetiot)
-  The documentation pages and the libraries of the entire package are shown on
-  the left sidebar.
+- Improved sidebar and breadcrumbs navigation (@panglesd, @gpetiot). The
+  documentation pages and the libraries of the entire package are shown on the
+  left sidebar.
 
-- Added support for images, videos, audio and other assets
-  The syntax is `{image!/reference/to/asset}` or `{image:URL}` for images.
-  The syntax for `{video...}` and `{audio...}` is the same.
-  (@panglesd, @EmileTrotignon, #1170, #1171, #1184, #1185)
+- Added support for images, videos, audio and other assets. The syntax is
+  `{image!/reference/to/asset}` or `{image:URL}` for images. The syntax for
+  `{video...}` and `{audio...}` is the same. (@panglesd, @EmileTrotignon,
+  #1170, #1171, #1184, #1185)
 
-- Search using Sherlodoc (@panglesd, @EmileTrotignon, @Julow)
-  A new search bar that supports full-text and type-based search.
+- Search using Sherlodoc (@panglesd, @EmileTrotignon, @Julow). A new search
+  bar that supports full-text and type-based search.
 
 ### Added
 
@@ -68,32 +31,40 @@
   `{!/otherpackage/page}`, `{!/otherpackage/Module.t}`.
 
 - Option to remap links to other packages to ocaml.org or other site.
-  See the `--remap` option of the driver or the `--remap-file` option of `odoc html-generate`.
-  (@jonludlam, #1189, #1248)
+  See the `--remap` option of the driver or the `--remap-file` option of
+  `odoc html-generate`. (@jonludlam, #1189, #1248)
 
 - Option to compute occurrences of use of each identifiers
   The commands `aggregate-occurrences` and `count-occurrences` are added.
   (@panglesd, #976, #1076, #1206)
 
+- Added an `extract-code` subcommand to extract code blocks from mld/mli files
+  (@panglesd, #1326)
+
 - Added the `odoc classify` command (@jonludlam, #1121)
   Helps driver detecting which modules belong to which libraries.
-- Added `--suppress-warnings` to the CLI to remove warnings from a unit, even
-  if they end up being raised in another unit through expansion
+- Added `--warnings-tag` options to the CLI to silence warnings from a unit,
+  even if they end up being raised in another unit through expansion
   (@jonludlam, #1260)
 - Add clock emoji before `@since` tag (@yawaramin, #1089)
-- Navigation for the search bar : use '/' to enter search, up and down arrows to
-  select a result, and enter to follow the selected link. (@EmileTrotignon, #1088)
-- Fix a big gap between the preamble and the content of a page (@EmileTrotignon, #1147)
-- Add a marshalled search index consumable by sherlodoc (@EmileTrotignon, @panglesd, #1084)
+- Navigation for the search bar : use '/' to enter search, up and down arrows
+  to select a result, and enter to follow the selected link. (@EmileTrotignon,
+  #1088)
+- Fix a big gap between the preamble and the content of a page
+  (@EmileTrotignon, #1147)
+- Add a marshalled search index consumable by sherlodoc (@EmileTrotignon,
+  @panglesd, #1084)
 - Allow referencing of polymorphic constructors in polymorphic variant type
   aliases (@panglesd, #1115)
 - Added a home icon in the breacrumbs (@panglesd, #1251)
   It can be disabled with a CLI option.
-- Add a frontmatter syntax for mld pages (@panglesd, #1187, #1193, #1243, #1246, #1251)
-  Allows to specify the title of a page, the order of sub-pages and other
-  behaviors in the sidebar.
+- Add a frontmatter syntax for mld pages (@panglesd, #1187, #1193, #1243,
+  #1246, #1251) Allows to specify the title of a page, the order of sub-pages
+  and other behaviors in the sidebar.
 - Added `odoc-md` to process standalone Markdown pages (@jonludlam, #1234)
-- Added CSS selectors to style version and and nav links when they appear within page titles, as produced by odig (@katrinafyi, #1290)
+- Added CSS selectors to style version and and nav links when they appear
+  within page titles, as produced by odig (@katrinafyi, #1290)
+- Added support for (local) images in the latex backend (@Octachron, #1297)
 
 ### Changed
 
@@ -127,6 +98,11 @@
 - Overhaul of module-type-of expansions and shadowing code (@jonludlam, #1081)
 - Output file paths and labels in the man and latex backends changed to avoid
   name clashes (@Julow, #1191)
+- Added a `header` field to the json output (@panglesd, #1314)
+- Changed indentation rules for code block and verbatim content (@panglesd,
+  #1317)
+- odoc-parser: Store raw content in verbatim and code block, and expose a
+  function to process it (@panglesd, #1325)
 
 ### Fixed
 
@@ -147,6 +123,10 @@
 - Add missing parentheses in 'val (let*) : ...' (@Julow, #1268)
 - Fix syntax highlighting not working for very large files
   (@jonludlam, @Julow, #1277)
+- Fix backtrace on invalid input in compile-deps (@jonludlam, #1313)
+- Fix bug in our CSS hitting verbatim blocks in tags (@jonludlam, #1312)
+- Fix issue #610 where `odoc html-fragment` wasn't rendering headings correctly
+  (@jonludlam, #1306)
 
 # 2.4.4