Skip to content

Commit d976b95

Browse files
committed
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 23fb3b7 commit d976b95

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
@@ -274,9 +274,24 @@ Build system and Infrastructure
274274
Documentation
275275
*************
276276

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

281296
Drivers and Sensors
282297
*******************

0 commit comments

Comments
 (0)