Skip to content

Commit 3925697

Browse files
kartbenmark-inderhees
authored andcommitted
doc: releases: Complete documentation release notes for 4.0
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é <[email protected]>
1 parent 2b711f1 commit 3925697

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

doc/releases/release-notes-4.0.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,9 +285,24 @@ Build system and Infrastructure
285285
Documentation
286286
*************
287287

288-
* Added two new build commands, ``make html-live`` and ``make html-live-fast``, that automatically locally
289-
host the generated documentation. They also automatically rebuild and rehost the documentation when changes
290-
to the input ``.rst`` files are detected on the filesystem.
288+
* Added a new :ref:`interactive board catalog <boards>` enabling users to search boards by criteria
289+
such as name, architecture, vendor, or SoC.
290+
* Added a new :zephyr:code-sample-category:`interactive code sample catalog <samples>` for quickly
291+
finding code samples based on name and description.
292+
* Added :rst:dir:`zephyr:board` directive and :rst:role:`zephyr:board` role to mark Sphinx pages as
293+
board documentation and reference them from other pages. Most existing board documentation pages
294+
have been updated to use this directive, with full migration planned for the next release.
295+
* Added :rst:dir:`zephyr:code-sample-category` directive to describe and group code samples in the
296+
documentation.
297+
* Added a link to the source code of the driver matching a binding's compatible string (when one can
298+
be found in the Zephyr tree) to the :ref:`dt-bindings` documentation.
299+
* Added a button to all code sample README pages allowing to directly browse the sample's source
300+
code on GitHub.
301+
* Moved Zephyr C API documentation out of main documentation. API references now feature a rich
302+
tooltip and link to the dedicated Doxygen site.
303+
* Added two new build commands, ``make html-live`` and ``make html-live-fast``, that automatically
304+
locally host the generated documentation. They also automatically rebuild and rehost the
305+
documentation when changes to the input ``.rst`` files are detected on the filesystem.
291306

292307
Drivers and Sensors
293308
*******************

0 commit comments

Comments
 (0)