Skip to content

Commit 01e3fe5

Browse files
committed
doc: TF-M: add TF-M docset wrapper
Added wrapper.rst and links.txt for the TF-M docset. NCSDK-32253. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 16f066f commit 01e3fe5

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@
280280
/doc/nrf/templates/ @nrfconnect/ncs-doc-leads
281281
/doc/nrf/test_and_optimize/ @nrfconnect/ncs-doc-leads
282282
/doc/nrf/test_and_optimize/optimizing/power_nrf91.rst @nrfconnect/ncs-cia-doc
283+
/doc/tfm/ @nrfconnect/ncs-aegir-doc
283284
/doc/wifi/ @sachinthegreen @krish2718
284285

285286
/doc/**/*.svg @nrfconnect/ncs-doc-leads

doc/tfm/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"zephyr.external_content",
4242
]
4343
source_suffix = [".rst", ".md"]
44+
master_doc = "wrapper"
4445

4546
exclude_patterns = [
4647
"platform/cypress/psoc64/security/keys/readme.rst"
@@ -87,6 +88,7 @@
8788
# Options for external_content -------------------------------------------------
8889

8990
external_content_contents = [
91+
(NRF_BASE / "doc" / "mcuboot", "*.rst"),
9092
(TFM_BASE / "docs", "**/*"),
9193
]
9294

doc/tfm/links.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. ### This page lists links used in the TF-M wrapper docs.
2+
Links are grouped by source URL if three or more have the same source URL.
3+
Otherwise, they are placed in "Source: other".
4+
Links not separated by blank line are related to one another.
5+
6+
.. ### Source: github.com
7+
8+
.. _`sdk-trusted-firmware-m`: https://github.com/nrfconnect/sdk-trusted-firmware-m
9+
10+
.. ### Source: www.nordicsemi.com
11+
12+
.. _`Nordic Semiconductor`: https://www.nordicsemi.com/
13+
14+
.. ### Source: docs.nordicsemi.com
15+
16+
.. _`Security section`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security.html
17+
18+
.. ### Source: *.trustedfirmware.*
19+
20+
.. _`Trusted Firmware-M (TF-M)`: https://www.trustedfirmware.org/projects/tf-m/
21+
22+
.. _`Trusted Firmware-M documentation`: https://trustedfirmware-m.readthedocs.io/en/latest/index.html

doc/tfm/wrapper.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _tfm_wrapper:
2+
3+
Trusted Firmware-M documentation
4+
################################
5+
6+
This section includes the official `Trusted Firmware-M (TF-M)`_ documentation.
7+
It is provided for reference only and is intended for the developers working on the integration of TF-M in the nRF Connect SDK.
8+
9+
The section renders the content of the `official TF-M documentation <Trusted Firmware-M documentation_>`_ as-is using the sources from the downstream `TF-M repository <sdk-trusted-firmware-m_>`_.
10+
11+
For information on how TF-M is integrated in the nRF Connect SDK, see the `Security section in the nRF Connect SDK documentation <Security section_>`_.

0 commit comments

Comments
 (0)