Docs: Restructuring and new layout
This patch implements a set of user-experiences aimed
changes.It modifies the documentation structure and
switches to a more reactive design for the rtd theme.
* The documentation layout has been redesigned to be more
intuitive,easier to maintain and and scale.
* The landing page introduces a new dashboard.
* Introduced dedicated space for release documents, and
changelog has been modified to directly source content
from referenced documents.
* Added quick-link navigation for items that need emphasis.
* Relevant design documents can now be grouped in suf-folders.
* There is dedicated space for custom platform, and third
party tools documents.
* Wildcard and regex matching has been introduced to indexes.
Change-Id: Ib02d17d5d26187d397ba17317788cf2a01401b07
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
diff --git a/docs/design_documents/booting_a_dual_core_system.rst b/docs/design_documents/dual-cpu/booting_a_dual_core_system.rst
similarity index 100%
rename from docs/design_documents/booting_a_dual_core_system.rst
rename to docs/design_documents/dual-cpu/booting_a_dual_core_system.rst
diff --git a/docs/design_documents/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst b/docs/design_documents/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
similarity index 100%
rename from docs/design_documents/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
rename to docs/design_documents/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
diff --git a/docs/design_documents/media/dual_core_mailbox_arch.png b/docs/design_documents/dual-cpu/dual_core_mailbox_arch.png
similarity index 100%
rename from docs/design_documents/media/dual_core_mailbox_arch.png
rename to docs/design_documents/dual-cpu/dual_core_mailbox_arch.png
Binary files differ
diff --git a/docs/design_documents/dual-cpu/index.rst b/docs/design_documents/dual-cpu/index.rst
new file mode 100644
index 0000000..f302748
--- /dev/null
+++ b/docs/design_documents/dual-cpu/index.rst
@@ -0,0 +1,12 @@
+Dual-CPU
+========
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ *
+
+--------------
+
+*Copyright (c) 2020, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/mailbox_design_on_dual_core_system.rst b/docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst
similarity index 99%
rename from docs/design_documents/mailbox_design_on_dual_core_system.rst
rename to docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst
index 45809bc..baa2e71 100644
--- a/docs/design_documents/mailbox_design_on_dual_core_system.rst
+++ b/docs/design_documents/dual-cpu/mailbox_design_on_dual_core_system.rst
@@ -86,7 +86,7 @@
The architecture is showed in following figure.
-.. figure:: media/dual_core_mailbox_arch.png
+.. figure:: dual_core_mailbox_arch.png
******************************************
Mailbox communication for PSA Client calls
diff --git a/docs/design_documents/tfm_multi_core_access_check.rst b/docs/design_documents/dual-cpu/tfm_multi_core_access_check.rst
similarity index 100%
rename from docs/design_documents/tfm_multi_core_access_check.rst
rename to docs/design_documents/dual-cpu/tfm_multi_core_access_check.rst
diff --git a/docs/design_documents/index.rst b/docs/design_documents/index.rst
new file mode 100644
index 0000000..9f85a76
--- /dev/null
+++ b/docs/design_documents/index.rst
@@ -0,0 +1,15 @@
+Design Documents
+================
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+ :glob:
+ :numbered:
+
+ */index
+ *
+
+--------------
+
+*Copyright (c) 2020, Arm Limited. All rights reserved.*
diff --git a/docs/design_documents/source_structure.rst b/docs/design_documents/source_structure.rst
index 66ca057..b22be0b 100644
--- a/docs/design_documents/source_structure.rst
+++ b/docs/design_documents/source_structure.rst
@@ -6,7 +6,7 @@
:Contact: tf-m@lists.trustedfirmware.org
.. note::
- Refernce the document :doc:`Glossary </docs/glossary>` for terms and
+ Refernce the document :doc:`Glossary </docs/reference/glossary>` for terms and
abbreviations.
************
diff --git a/docs/design_documents/symmetric_initial_attest.rst b/docs/design_documents/symmetric_initial_attest.rst
index 7807fac..a763433 100644
--- a/docs/design_documents/symmetric_initial_attest.rst
+++ b/docs/design_documents/symmetric_initial_attest.rst
@@ -590,7 +590,7 @@
.. [2] :doc:`Trusted Firmware-M Profile Small Design </docs/design_documents/tfm_profile_small>`
-.. [3] :doc:`Initial Attestation Service Integration Guide </docs/user_guides/services/tfm_attestation_integration_guide>`
+.. [3] :doc:`Initial Attestation Service Integration Guide </docs/reference/services/tfm_attestation_integration_guide>`
.. [4] `HMAC: Keyed-Hashing for Message Authentication <https://tools.ietf.org/html/rfc2104>`_
diff --git a/docs/design_documents/tfm_profile_small.rst b/docs/design_documents/tfm_profile_small.rst
index 1353bbf..d427aab 100644
--- a/docs/design_documents/tfm_profile_small.rst
+++ b/docs/design_documents/tfm_profile_small.rst
@@ -703,15 +703,15 @@
.. [6] `Transitioning the Use of Cryptographic Algorithms and Key Lengths <https://www.nist.gov/publications/transitioning-use-cryptographic-algorithms-and-key-lengths>`_
-.. [7] :doc:`ITS integration guide </docs/user_guides/services/tfm_its_integration_guide>`
+.. [7] :doc:`ITS integration guide </docs/reference/services/tfm_its_integration_guide>`
.. [8] `PSA Attestation API 1.0 (ARM IHI 0085) <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Implement/IHI0085-PSA_Attestation_API-1.0.2.pdf?revision=eef78753-c77e-4b24-bcf0-65596213b4c1&la=en&hash=E5E0353D612077AFDCE3F2F3708A50C77A74B2A3>`_
-.. [9] :doc:`Secure boot </docs/user_guides/tfm_secure_boot>`
+.. [9] :doc:`Secure boot </docs/getting_started/tfm_secure_boot>`
.. [10] :doc:`Crypto design </docs/design_documents/tfm_crypto_design>`
-.. [11] :doc:`TF-M build instruction </docs/user_guides/tfm_build_instruction>`
+.. [11] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
--------------
diff --git a/docs/design_documents/tfm_secure_partition_interrupt_handling.rst b/docs/design_documents/tfm_secure_partition_interrupt_handling.rst
index a0c998e..95a6c82 100644
--- a/docs/design_documents/tfm_secure_partition_interrupt_handling.rst
+++ b/docs/design_documents/tfm_secure_partition_interrupt_handling.rst
@@ -28,7 +28,7 @@
.. code-block:: json
- "irqs": [
+ {"irqs": [
{
"line_num": 17,
"signal": "RTC"
@@ -37,7 +37,7 @@
"line_name": "UART1_IRQ",
"signal": "UART1"
}
- ]
+ ]}
Partition ISR function
======================
@@ -227,4 +227,4 @@
- ``irq_signal`` indicates more than one signal.
- ``irq_signal`` is not currently asserted.
-*Copyright (c) 2019-2020, Arm Limited. All rights reserved.*
\ No newline at end of file
+*Copyright (c) 2019-2020, Arm Limited. All rights reserved.*
