Skip to content

Combined sphinx and doxygen update - #31403

Open
andu-nordic wants to merge 4 commits into
nrfconnect:mainfrom
andu-nordic:feat/doxygen-and-sphinx-upgrade
Open

andu-nordic wants to merge 4 commits into
nrfconnect:mainfrom
andu-nordic:feat/doxygen-and-sphinx-upgrade

Conversation

@andu-nordic

Copy link
Copy Markdown
Contributor

This updates doxygen to 1.15.0 and sphinx to 9.1.x

Relevant Sphinx issues fixed:

  • changes in how docutils handle references in substitution
  • removal/replacement of deprecated python api usage

For doxygen it was necessary to upgrade the doxygen-awesome theme.

Update stylesheets from doxygen-awesome with latest version.
Additionaly instead of modifying the stylesheets directly
introduce a custom.css file so that future updates can be
easier.

Signed-off-by: Antoni Duda <antoni.duda@nordicsemi.no>
Updating tools-versions files with new doxygen version.

Signed-off-by: Antoni Duda <antoni.duda@nordicsemi.no>
Automated run of doxygen -u path/to/doxyfile.in was used
to update doxyfiles to the new version.

PAGE_OUTLINE_PANEL = NO needs now to be explicitly set.

Signed-off-by: Antoni Duda <antoni.duda@nordicsemi.no>
Update sphinx version used for docbuild. Fixes relevant issues
regarding:
- changes in how docutils handle references in substitution
- removal/replacement of deprecated python api usage

Signed-off-by: Antoni Duda <antoni.duda@nordicsemi.no>
@NordicBuilder NordicBuilder added the doc-required PR must not be merged without tech writer approval. label Sep 17, 2026
@NordicBuilder

NordicBuilder commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

CI Information

To view the history of this post, click the 'edited' button above
Build number: 1

Inputs:

Sources:

sdk-nrf: PR head: 45491d796ec7cf22e0009ba1278f3afce658b7a3

more details

sdk-nrf:

PR head: 45491d796ec7cf22e0009ba1278f3afce658b7a3
merge base: 4bfa692e9acb5eff2926e4ccf68571ed30d869db
target head (main): 4bfa692e9acb5eff2926e4ccf68571ed30d869db
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
ci-run-draft Run CI on draft pull requests
List of changed files detected by CI (20)
doc
│  ├── _doxygen
│  │  ├── custom.css
│  │  ├── doxygen-awesome-darkmode-toggle.js
│  │  ├── doxygen-awesome-interactive-toc.js
│  │  ├── doxygen-awesome-paragraph-link.js
│  │  │ doxygen-awesome.css
│  ├── _extensions
│  │  ├── ncs_include
│  │  │  │ ncs_include.py
│  │  │ table_from_rows.py
│  ├── nrf
│  │  ├── dev_model_and_contributions
│  │  │  ├── documentation
│  │  │  │  │ build.rst
│  │  ├── nrf.doxyfile.in
│  │  │ shortcuts.txt
│  ├── nrfx
│  │  │ nrfx.doxyfile.in
│  ├── nrfxlib
│  │  │ nrfxlib.doxyfile.in
│  ├── requirements.txt
│  ├── wifi
│  │  │ wifi.doxyfile.in
│  ├── zephyr
│  │  ├── conf.py
│  │  │ zephyr.doxyfile.in
scripts
│  ├── ci
│  │  │ license_allow_list.yaml
│  ├── tools-versions-darwin.yml
│  ├── tools-versions-linux.yml
│  │ tools-versions-win10.yml

Outputs:

Toolchain

Version: 3645d22f6f
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:3645d22f6f_a140d687bb

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
  • ❌ Integration tests
    • ✅ test-sdk-audio
    • ✅ desktop52_verification
    • ✅ test-fw-nrfconnect-apps_nrfdesktop
    • ✅ test-fw-nrfconnect-apps
    • ✅ test_ble_nrf_config
    • ✅ test-fw-nrfconnect-ble_mesh
    • ✅ test-fw-nrfconnect-ble_samples
    • ✅ test-fw-nrfconnect-nfc
    • ✅ test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • ✅ test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • ✅ test-fw-nrfconnect-nrf-iot_samples
    • ✅ test-fw-nrfconnect-nrf-iot_lwm2m
    • ✅ test-fw-nrfconnect-nrf_crypto
    • ✅ test-fw-nrfconnect-rpc
    • ✅ test-fw-nrfconnect-rs
    • ✅ test-fw-nrfconnect-fem
    • ✅ test-fw-nrfconnect-tfm
    • ✅ test-fw-nrfconnect-thread-main
    • ✅ test-sdk-find-my
    • ✅ test-fw-nrfconnect-nrf_lrcs_mosh
    • ✅ test-fw-nrfconnect-nrf_lrcs_positioning
    • ❌ test-sdk-wifi
    • ✅ test-sdk-wifi-net
    • ✅ test-sdk-wifi-wezen-7120
    • ✅ test-low-level
    • ✅ test-sdk-mcuboot
    • ✅ test-sdk-dfu
    • ✅ test-fw-nrfconnect-ps-main

Note: This message is automatically posted and updated by the CI

@github-actions

Copy link
Copy Markdown

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsbmdoc.z6.web.core.windows.net/ncs/PR-31403/nrf/dev_model_and_contributions/documentation/build.html

@NordicBuilder

Copy link
Copy Markdown
Contributor

Memory footprint analysis revealed the following potential issues

applications.hpf.gpio.icmsg[nrf54l15dk/nrf54l15/cpuflpr]: High RAM usage: 9549[B] - link (cc: @nrfconnect/ncs-ll-ursus)
applications.hpf.gpio.icmsg[nrf54l15dk/nrf54l15/cpuflpr]: High ROM usage: 6296[B] - link (cc: @nrfconnect/ncs-ll-ursus)
applications.hpf.gpio.mbox[nrf54l15dk/nrf54l15/cpuflpr]: High RAM usage: 7389[B] - link (cc: @nrfconnect/ncs-ll-ursus)
applications.hpf.gpio.mbox[nrf54l15dk/nrf54l15/cpuflpr]: High ROM usage: 4148[B] - link (cc: @nrfconnect/ncs-ll-ursus)

Note: This message is automatically posted and updated by the CI (latest/sdk-nrf/PR-31403/1)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DNM doc-required PR must not be merged without tech writer approval. no-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants