From d976b9521c1b720e9165191e6e1daacdecd516e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Mon, 4 Nov 2024 12:24:26 +0100 Subject: [PATCH] doc: releases: Complete documentation release notes for 4.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This completes the existing "Documentation" section of the release notes for 4.0 by documenting the various changes/improvements implemented during the last development cycle. Signed-off-by: Benjamin Cabé --- doc/releases/release-notes-4.0.rst | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/doc/releases/release-notes-4.0.rst b/doc/releases/release-notes-4.0.rst index c47b46e588ba0..208b6b1ae7c5a 100644 --- a/doc/releases/release-notes-4.0.rst +++ b/doc/releases/release-notes-4.0.rst @@ -274,9 +274,24 @@ Build system and Infrastructure Documentation ************* - * Added two new build commands, ``make html-live`` and ``make html-live-fast``, that automatically locally - host the generated documentation. They also automatically rebuild and rehost the documentation when changes - to the input ``.rst`` files are detected on the filesystem. +* Added a new :ref:`interactive board catalog ` enabling users to search boards by criteria + such as name, architecture, vendor, or SoC. +* Added a new :zephyr:code-sample-category:`interactive code sample catalog ` for quickly + finding code samples based on name and description. +* Added :rst:dir:`zephyr:board` directive and :rst:role:`zephyr:board` role to mark Sphinx pages as + board documentation and reference them from other pages. Most existing board documentation pages + have been updated to use this directive, with full migration planned for the next release. +* Added :rst:dir:`zephyr:code-sample-category` directive to describe and group code samples in the + documentation. +* Added a link to the source code of the driver matching a binding's compatible string (when one can + be found in the Zephyr tree) to the :ref:`dt-bindings` documentation. +* Added a button to all code sample README pages allowing to directly browse the sample's source + code on GitHub. +* Moved Zephyr C API documentation out of main documentation. API references now feature a rich + tooltip and link to the dedicated Doxygen site. +* Added two new build commands, ``make html-live`` and ``make html-live-fast``, that automatically + locally host the generated documentation. They also automatically rebuild and rehost the + documentation when changes to the input ``.rst`` files are detected on the filesystem. Drivers and Sensors *******************