Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/_extensions/zephyr/domain/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from typing import Any, Dict, Iterator, List, Tuple, Final

from docutils import nodes
from docutils.parsers.rst import Directive, directives
from docutils.parsers.rst import directives
from docutils.statemachine import StringList

from sphinx import addnodes
Expand Down Expand Up @@ -434,7 +434,7 @@ def run(self, **kwargs: Any) -> None:
node.replace_self([])


class CodeSampleDirective(Directive):
class CodeSampleDirective(SphinxDirective):
"""
A directive for creating a code sample node in the Zephyr documentation.
"""
Expand Down
3 changes: 2 additions & 1 deletion doc/_extensions/zephyr/domain/templates/board-card.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
tabindex="0">
<div class="vendor">{{ catalog.vendors[board.vendor] }}</div>
{% if board.image -%}
<img alt="A picture of the {{ board.name }} board" src="{{ board.image }}" class="picture" />
<img alt="A picture of the {{ board.full_name }} board"
src="../_images/{{ board.image.split('/')[-1] }}" class="picture" />
{% else -%}
<div class="no-picture fa fa-microchip picture"></div>
{% endif -%}
Expand Down
6 changes: 2 additions & 4 deletions doc/_scripts/gen_boards_catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
from pathlib import Path

import list_boards, list_hardware
import pykwalify
import yaml
import zephyr_module
from gen_devicetree_rest import VndLookup
Expand Down Expand Up @@ -35,8 +34,8 @@ def guess_image(board_or_shield):
img_file = guess_file_from_patterns(
board_or_shield.dir, patterns, board_or_shield.name, img_exts
)
return (Path("../_images") / img_file.name).as_posix() if img_file else ""

return (img_file.relative_to(ZEPHYR_BASE)).as_posix() if img_file else None

def guess_doc_page(board_or_shield):
patterns = [
Expand All @@ -52,8 +51,6 @@ def guess_doc_page(board_or_shield):


def get_catalog():
pykwalify.init_logging(1)

vnd_lookup = VndLookup(ZEPHYR_BASE / "dts/bindings/vendor-prefixes.txt", [])

module_settings = {
Expand Down Expand Up @@ -106,6 +103,7 @@ def get_catalog():
doc_page = guess_doc_page(board)

board_catalog[board.name] = {
"name": board.name,
"full_name": full_name,
"doc_page": doc_page.relative_to(ZEPHYR_BASE).as_posix() if doc_page else None,
"vendor": vendor,
Expand Down
16 changes: 8 additions & 8 deletions doc/releases/release-notes-3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -834,15 +834,15 @@ Drivers and Sensors
* Added support for Ambiq Apollo3 series.
* Added support for multiple instances of the SPI NOR driver (spi_nor.c).
* Added preliminary support for non-erase devices with introduction of
device capabilities to c:struct:`flash_parameters` and the utility function
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of weird to be modifying release notes of an already finalized release.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #79994 (comment) for some context

c:func:`flash_params_get_erase_cap` that allows to obtain the erase type
provided by a device; added c:macro:`FLASH_ERASE_C_EXPLICIT`, which is
device capabilities to :c:struct:`flash_parameters` and the utility function
:c:func:`flash_params_get_erase_cap` that allows to obtain the erase type
provided by a device; added :c:macro:`FLASH_ERASE_C_EXPLICIT`, which is
currently the only supported erase type and is set by all flash devices.
* Added the c:func:`flash_flatten` function that can be used on devices,
* Added the :c:func:`flash_flatten` function that can be used on devices,
with or without erase requirement, when erase has been used not for preparing
a device for a random data write, but rather to remove/scramble data from
that device.
* Added the c:func:`flash_fill` utility function which allows to write
* Added the :c:func:`flash_fill` utility function which allows to write
a single value across a provided range in a selected device.
* Added support for RRAM on nrf54l15 devices.
* Added support of non busy wait polling in STM32 OSPI driver.
Expand All @@ -868,7 +868,7 @@ Drivers and Sensors

* Added support for Ambiq Apollo3 series.
* Added Broadcom Set-top box(brcmstb) SoC GPIO driver.
* Added c:macro:`STM32_GPIO_WKUP` flag which allows to configure specific pins as wakeup source
* Added :c:macro:`STM32_GPIO_WKUP` flag which allows to configure specific pins as wakeup source
from Power Off state on STM32 L4, U5, WB, & WL SoC series.
* Added driver for Analog Devices MAX32 SoC series.
* Added support for Nuvoton Numaker M2L31X series.
Expand Down Expand Up @@ -1047,7 +1047,7 @@ Drivers and Sensors
* Added support for STM32H7R/S series.
* Added a Add QTMR PWM driver for NXP imxrt11xx
* Made the NXP MCUX PWM driver thread safe
* Fix zephyr:code-sample:`pwm-blinky` code sample to demonstrate PWM support for
* Fix :zephyr:code-sample:`pwm-blinky` code sample to demonstrate PWM support for
:ref:`beagleconnect_freedom`.
* Added driver for ENE KB1200.
* Added support for Nordic nRF54H and nRF54L Series SoCs.
Expand Down Expand Up @@ -1403,7 +1403,7 @@ Networking
* Implemented IPv6 Privacy Extensions according to RFC 8981.
* Added :c:func:`net_ipv6_is_private_addr` API function.
* Implemented reachability hint for IPv6. Upper layers can use
c:func:`net_if_nbr_reachability_hint` to report Neighbor reachability and
:c:func:`net_if_nbr_reachability_hint` to report Neighbor reachability and
avoid unnecessary Neighbor Discovery solicitations.
* Added :kconfig:option:`CONFIG_NET_IPV6_MTU` allowing to set custom IPv6 MTU.
* Added :kconfig:option:`CONFIG_NET_MCAST_ROUTE_MAX_IFACES` which allows to set
Expand Down