Skip to content

Commit e52d4be

Browse files
greg-ferrlubos
authored andcommitted
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 <[email protected]>
1 parent adc5732 commit e52d4be

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@
276276
/doc/nrf/templates/ @nrfconnect/ncs-doc-leads
277277
/doc/nrf/test_and_optimize/ @nrfconnect/ncs-doc-leads
278278
/doc/nrf/test_and_optimize/optimizing/power_nrf91.rst @nrfconnect/ncs-cia-doc
279+
/doc/tfm/ @nrfconnect/ncs-aegir-doc
279280
/doc/wifi/ @sachinthegreen @krish2718
280281

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

doc/tfm/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,13 @@
4141
"zephyr.external_content",
4242
]
4343
source_suffix = [".rst", ".md"]
44+
master_doc = "wrapper"
45+
46+
linkcheck_ignore = [r"(\.\.(\\|/))+(kconfig|zephyr)"]
4447

4548
exclude_patterns = [
4649
"platform/cypress/psoc64/security/keys/readme.rst"
50+
"index.rst"
4751
]
4852

4953
numfig = True
@@ -87,6 +91,7 @@
8791
# Options for external_content -------------------------------------------------
8892

8993
external_content_contents = [
94+
(NRF_BASE / "doc" / "tfm", "wrapper.rst"),
9095
(TFM_BASE / "docs", "**/*"),
9196
]
9297

doc/tfm/wrapper.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _tfm_wrapper:
2+
3+
Trusted Firmware-M documentation
4+
################################
5+
6+
This section includes the official `Trusted Firmware-M (TF-M) <https://www.trustedfirmware.org/projects/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 <https://trustedfirmware-m.readthedocs.io/en/latest/index.html>`_ as-is using the sources from the downstream `TF-M repository <https://github.com/nrfconnect/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 <https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/security.html>`_.
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
:caption: Contents
16+
17+
introduction/index.rst
18+
getting_started/index.rst
19+
security/index.rst
20+
releases/index.rst
21+
roadmap.rst
22+
glossary.rst
23+
platform/index.rst
24+
building/tfm_build_instruction.rst
25+
configuration/index.rst
26+
integration_guide/index.rst
27+
design_docs/index.rst
28+
contributing/index.rst
29+
contributing/lic.rst
30+
contributing/dco.rst

0 commit comments

Comments
 (0)