docs: Decouple refrences from /docs folder

Signed-off-by: Anton Komlev <[email protected]>
Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22

Author: Anton-TF

docs/conf.py.in

@@ -20,8 +20,6 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
-sys.path.insert(0, os.path.abspath('../docs'))
 
 # -- Project information -----------------------------------------------------
 

docs/contributing/code_review_guide.rst

@@ -4,7 +4,7 @@ Code Review Guideline
 The purpose of this document is to clarify design items to be reviewed during
 the code review process.
 
-Please contact :doc:`maintainers </docs/contributing/maintainers>` or write an e-mail
+Please contact :doc:`maintainers </contributing/maintainers>` or write an e-mail
 thread on the `TF-M mailing list <mailto:[email protected]>`_ for
 any questions.
 
@@ -13,9 +13,9 @@ List of the guidelines
 **********************
 The prerequisites before going to the review stage:
 
-- Read the :doc:`Contributing Process </docs/contributing/contributing_process>`
+- Read the :doc:`Contributing Process </contributing/contributing_process>`
   to know basic concepts.
-- Read the :doc:`Source Structure </docs/technical_references/design_docs/source_structure>`
+- Read the :doc:`Source Structure </technical_references/design_docs/source_structure>`
   for structure related reference.
 
 The review guidelines consist of these items:

docs/contributing/coding_guide.rst

@@ -18,7 +18,7 @@ remain within clear scope.
 The guidance below is provided as a help. It isn't meant to be a definitive
 list.
 
-As implied in the :doc:`contributing guide </docs/contributing/contributing_process>`
+As implied in the :doc:`contributing guide </contributing/contributing_process>`
 maintainers have the right to decide on what's acceptable in case of any
 divergence.
 

docs/contributing/contributing_process.rst

@@ -5,7 +5,7 @@ Contributions to the TF-M project need to follow the process below.
 
 .. Note::
 
-   Please contact :doc:`maintainers </docs/contributing/maintainers>` for any
+   Please contact :doc:`maintainers </contributing/maintainers>` for any
    questions.
 
 - Subscribe to `TF-M development
@@ -19,22 +19,22 @@ Contributions to the TF-M project need to follow the process below.
   <https://developer.trustedfirmware.org/maniphest>`_, put as many details as
   possible in the description. Add 'Trusted Firmware M' in the 'Tags' field.
 - For non-trivial changes, need to follow the design proposal process
-  :doc:`Design Proposal Guideline </docs/contributing/tfm_design_proposal_guideline>`
+  :doc:`Design Proposal Guideline </contributing/tfm_design_proposal_guideline>`
   for the TF-M project.
 - After the design has been accepted by the maintainer(s), a corresponding
   patch should be posted; follow guidelines below:
 
   - Clone the TF-M code on your own machine from `TF-M git repository
     <https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git>`_.
-  - Follow the :doc:`TF-M getting started </docs/getting_started/tfm_getting_started>`,
-    :doc:`Build Instructions </docs/technical_references/instructions/tfm_build_instruction>` and
-    :doc:`Coding Guide </docs/contributing/coding_guide>` for the TF-M project.
+  - Follow the :doc:`TF-M getting started </getting_started/tfm_getting_started>`,
+    :doc:`Build Instructions </technical_references/instructions/tfm_build_instruction>` and
+    :doc:`Coding Guide </contributing/coding_guide>` for the TF-M project.
   - Make your changes in logical chunks to help reviewers. Each commit should
     be a separate review and either work properly or be squashed after the
     review and before merging.
   - Update documentation in docs/ folder if needed.
   - Test your changes and add details to the commit description.
-  - The code is accepted under :doc:`DCO </docs/contributing/dco>`, Developer
+  - The code is accepted under :doc:`DCO </contributing/dco>`, Developer
     Certificate of Origin, so you must add following fields to your
     commit description:
 
@@ -66,7 +66,7 @@ Contributions to the TF-M project need to follow the process below.
 
        git push https://review.trustedfirmware.org/TF-M/trusted-firmware-m.git HEAD:refs/for/master
 
-- Add relevant :doc:`maintainers </docs/contributing/maintainers>` for reviewing
+- Add relevant :doc:`maintainers </contributing/maintainers>` for reviewing
   the patch.
 - You may be asked to provide further details or make additional changes.
 - You can discuss further with maintainer(s) by directly over email if

docs/contributing/doc_guidelines.rst

@@ -20,7 +20,7 @@ The following short-list provides a quick summary of the rules.
 
 - If the patch modifies a present file, the file's style should be followed
 - If creating a new file,
-  :doc:`integration guide </docs/integration_guide/tfm_integration_guide>` can be used as a reference.
+  :doc:`integration guide </integration_guide/tfm_integration_guide>` can be used as a reference.
 - When a new style is to be expressed, consult the `Python Documentation Guidelines`_
 
 *************
@@ -186,8 +186,8 @@ will not be added to the index (So it cannot be referenced if needed)
    +--------------+--------------+-------------+
 
 Other types of tables such as list-tables and csv-tables are also permitted, as
-seen on :doc:`/docs/getting_started/tfm_getting_started` and
-:doc:`/docs/releases/1.0`
+seen on :doc:`/getting_started/tfm_getting_started` and
+:doc:`/releases/1.0`
 
 
 External Links
@@ -236,7 +236,7 @@ A document included in the documentation can be referenced by the `doc:` notatio
 
 .. code-block:: restructuredtext
 
-    :doc:`integration guide </docs/integration_guide/tfm_integration_guide>`
+    :doc:`integration guide </integration_guide/tfm_integration_guide>`
 
 The path is relative to the root of the Trusted Firmware-M code.
 
@@ -260,7 +260,7 @@ Glossary term
 =============
 
 For technical terms and abbreviations, the recommended guidance is to add an
-entry to the :doc:`/docs/glossary` and refer to it, using the `term:`
+entry to the :doc:`/glossary` and refer to it, using the `term:`
 directive
 
 
@@ -293,7 +293,7 @@ References
 .. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _Restructed Text: https://docutils.sourceforge.io/rst.html
 .. _Python Documentation Guidelines: https://devguide.python.org/documenting/#style-guide
-.. _Pygments Lexers: https://pygments.org/docs/lexers/
+.. _Pygments Lexers: https://pygments.org/lexers/
 
 --------------
 

docs/contributing/tfm_design_proposal_guideline.rst

@@ -111,7 +111,7 @@ Reference
 
 .. [3] `TF-M gerrit <https://review.trustedfirmware.org/q/project:TF-M/trusted-firmware-m>`_
 
-.. [4] :doc:`Contributing process </docs/contributing/contributing_process>`
+.. [4] :doc:`Contributing process </contributing/contributing_process>`
 
 -------------------
 

docs/getting_started/tfm_getting_started.rst

@@ -415,10 +415,10 @@ Next steps
 
 Here are some next steps for exploring TF-M:
 
-    - Detailed :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
-    - :doc:`IAR Build instructions </docs/technical_references/instructions/tfm_build_instruction_iar>`.
-    - Try other :doc:`Samples and Demos </docs/technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
-    - :doc:`Documentation generation </docs/technical_references/instructions/documentation_generation>`.
+    - Detailed :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
+    - :doc:`IAR Build instructions </technical_references/instructions/tfm_build_instruction_iar>`.
+    - Try other :doc:`Samples and Demos </technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
+    - :doc:`Documentation generation </technical_references/instructions/documentation_generation>`.
 
 --------------
 

docs/index.rst

@@ -15,15 +15,15 @@ Trusted Firmware-M Documentation
 
     <ul class="grid">
         <li class="grid-item">
-            <a href="docs/introduction/readme.html">
+            <a href="introduction/readme.html">
                 <img alt="" src="_static/images/tfm-introduction.png"/>
                 <h2>Introduction</h2>
             </a>
             <p>Introducing the Trusted Firmware-M Project: overview,
                architecture, features, and licensing.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/getting_started/index.html">
+            <a href="getting_started/index.html">
                <img alt="" src="_static/images/tfm-documentation.png"/>
                <h2>Getting Started</h2>
             </a>
@@ -38,37 +38,37 @@ Trusted Firmware-M Documentation
             <p>List of supported boards and platforms.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/contributing/index.html">
+            <a href="contributing/index.html">
                 <img alt="" src="_static/images/tfm-contribution.png"/>
                 <h2>Contribution</h2>
             </a>
             <p>As an open-source project, we welcome and encourage the community
                to submit patches directly to the project.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/integration_guide/index.html">
+            <a href="integration_guide/index.html">
                 <img alt="" src="_static/images/tfm-integration.png"/>
                 <h2>Integration</h2>
             </a>
             <p>Guidelines for integration with TF-M.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/technical_references/index.html">
+            <a href="technical_references/index.html">
                 <img alt="" src="_static/images/tfm-reference.png"/>
                 <h2>References</h2>
             </a>
             <p>Design documents.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/security/index.html">
+            <a href="security/index.html">
                 <img alt="" src="_static/images/tfm.png"/>
                 <h2>Security</h2>
             </a>
             <p>Requirements, processes, and thread models for ensuring security
                is addressed within the TF-M project.</p>
         </li>
         <li class="grid-item">
-            <a href="docs/releases/index.html">
+            <a href="releases/index.html">
                 <img alt="" src="_static/images/tfm-release.png"/>
                 <h2>Releases</h2>
             </a>
@@ -84,14 +84,14 @@ Trusted Firmware-M Documentation
     :hidden:
 
     Home<self>
-    docs/introduction/index
-    docs/getting_started/index
+    introduction/index
+    getting_started/index
     platform/ext/index
-    docs/contributing/index
-    docs/integration_guide/index
-    docs/technical_references/index
-    docs/security/index
-    docs/releases/index
+    contributing/index
+    integration_guide/index
+    technical_references/index
+    security/index
+    releases/index
 
 
 .. toctree::
@@ -102,7 +102,7 @@ Trusted Firmware-M Documentation
     API Reference <https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/reference_manual/html/index.html>
     Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
     Platform Security Architecture <https://developer.arm.com/architectures/security-architectures/platform-security-architecture>
-    docs/glossary
+    glossary
 
 --------------
 

docs/integration_guide/os_migration_guide_armv8m.rst

@@ -18,7 +18,7 @@ List of requirements
   value used in Handler mode transitions needs to be differentiated between
   Secure and Non Secure builds, i.e. ``0xFD`` and ``0xBC``, respectively.
 - If the OS manages the non-secure client identification, pelase check the
-  :doc:`Non-secure Client Extension Integration Guide </docs/integration_guide/non-secure_client_extension_integration_guide>`.
+  :doc:`Non-secure Client Extension Integration Guide </integration_guide/non-secure_client_extension_integration_guide>`.
 
 --------------
 

docs/integration_guide/porting_TFM_to_a_new_hardware.rst

@@ -10,7 +10,7 @@ exist on the platform for TF-M (S and NS) to run on this new platform.
 ******************
 TF-M in a nutshell
 ******************
-For an overview please refer to :doc:`Introduction </docs/introduction/readme>`.
+For an overview please refer to :doc:`Introduction </introduction/readme>`.
 
 *************
 Prerequisites
@@ -19,12 +19,12 @@ Building environnement
 ======================
 Make sure you have a working build environnement and that you can build
 TF-M on AN521 following the
-:doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
+:doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
 
 Toolchains and software requirements
 ====================================
 
-Please follow the :doc:`Getting started guide </docs/getting_started/tfm_getting_started>`.
+Please follow the :doc:`Getting started guide </getting_started/tfm_getting_started>`.
 
 CMSIS Drivers
 =============
@@ -59,7 +59,7 @@ In a nutshell, this should be a 6 iterative steps process:
 
     #. Running the regression tests
 
-        - See :doc:`Running TF-M on Arm platforms </docs/technical_references/instructions/run_tfm_examples_on_arm_platforms>`
+        - See :doc:`Running TF-M on Arm platforms </technical_references/instructions/run_tfm_examples_on_arm_platforms>`
           as an example
 
 

docs/integration_guide/services/tfm_attestation_integration_guide.rst

@@ -625,9 +625,9 @@ that user has license for DS-5 and FVP models:
 
  - Build TF-M with any of the ``ConfigRegression*.cmake`` build configurations
    for MPS2 AN521 platform. More info in
-   :doc:`tfm_build_instruction </docs/technical_references/instructions/tfm_build_instruction>`.
+   :doc:`tfm_build_instruction </technical_references/instructions/tfm_build_instruction>`.
  - Lunch FVP model in DS-5. More info in
-   :doc:`Run TF-M examples on Arm platforms </docs/technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
+   :doc:`Run TF-M examples on Arm platforms </technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
  - Set a breakpoint in ``test/secure_fw/suites/attestation/attest_token_test.c``
    in ``decode_test_internal(..)`` after the ``token_main_alt(..)`` returned,
    i.e. on line 859. Execute the code in the model until the breakpoint hits

docs/integration_guide/services/tfm_ps_integration_guide.rst

@@ -156,7 +156,7 @@ The ITS filesystem and flash interfaces and their implementation can be found in
 ``secure_fw/partitions/internal_trusted_storage/flash`` respectively. More
 information about the filesystem and flash interfaces can be found in the
 :doc:`ITS integration guide
-</docs/integration_guide/services/tfm_its_integration_guide>`.
+</integration_guide/services/tfm_its_integration_guide>`.
 
 The ITS service implementation in
 ``secure_fw/partitions/internal_trusted_storage/tfm_internal_trusted_storage.c``,
@@ -291,14 +291,14 @@ TF-M core tracks the current client IDs running in the secure or non-secure
 processing environment. It provides a dedicated API to retrieve the client ID
 which performs the service request.
 
-:doc:`Non-secure Client Extension Integration Guide </docs/integration_guide/non-secure_client_extension_integration_guide>`
+:doc:`Non-secure Client Extension Integration Guide </integration_guide/non-secure_client_extension_integration_guide>`
 provides further details on how client identification works.
 
 PS service uses that TF-M core API to retrieve the client ID and associate it
 as the owner of an asset. Only the owner can read, write or delete that asset
 based on the creation flags.
 
-The :doc:`integration guide </docs/integration_guide/tfm_integration_guide>`
+The :doc:`integration guide </integration_guide/tfm_integration_guide>`
 provides further details of non-secure implementation requirements for TF-M.
 
 Cryptographic Interface

docs/integration_guide/services/tfm_psa_proxy_integration_guide.rst

@@ -9,7 +9,7 @@ TF-M PSA Proxy partition is responsible for forwarding all the PSA RoT messages
 to a Secure Enclave, this way virtually providing all the PSA RoT services.
 Proxy can only be used in IPC model, for context and design details please
 check the
-:doc:`Secure Enclave design document </docs/technical_references/design_docs/secure_enclave_solution>`.
+:doc:`Secure Enclave design document </technical_references/design_docs/secure_enclave_solution>`.
 
 Currently to forward the PSA Client call parameters Proxy must read them with
 ``psa_read`` into a memory area shared with the Secure Enclave. (Similarily

docs/integration_guide/services/tfm_secure_partition_addition.rst

@@ -555,7 +555,7 @@ it from somewhere. One option is to create a new testsuite, such as
 interface_testsuite.c``.
 
 The process of adding test connection is explained in the specification
-:doc:`Adding TF-M Regression Test Suite </docs/integration_guide/tfm_test_suites_addition>`
+:doc:`Adding TF-M Regression Test Suite </integration_guide/tfm_test_suites_addition>`
 
 .. code-block:: c
 

docs/integration_guide/tfm_fpu_support.rst

@@ -105,7 +105,7 @@ Reference
 
 .. [5] `Arm® Platform Security Architecture Firmware Framework 1.0 <https://armkeil.blob.core.windows.net/developer/Files/pdf/PlatformSecurityArchitecture/Architect/DEN0063-PSA_Firmware_Framework-1.0.0-2.pdf>`_
 
-.. [6] :doc:`Secure Interrupt Integration Guide </docs/integration_guide/tfm_secure_irq_integration_guide>`
+.. [6] :doc:`Secure Interrupt Integration Guide </integration_guide/tfm_secure_irq_integration_guide>`
 
 .. [7] `Musca-S1 Test Chip Board <https://developer.arm.com/tools-and-software/development-boards/iot-test-chips-and-boards/musca-s1-test-chip-board>`_
 

docs/integration_guide/tfm_integration_guide.rst

@@ -7,18 +7,18 @@ with other hardware platforms and operating systems.
 *****************
 How to build TF-M
 *****************
-Follow the :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
+Follow the :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
 
 ********************************************************
 How to export files for building non-secure applications
 ********************************************************
-Explained in the :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
+Explained in the :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
 
 *************************
 How to add a new platform
 *************************
 
-:doc:`Porting TF-M to a New Hardware </docs/integration_guide/porting_TFM_to_a_new_hardware>`
+:doc:`Porting TF-M to a New Hardware </integration_guide/porting_TFM_to_a_new_hardware>`
 contains guidance on how to add a new platform.
 
 ***************************
@@ -58,7 +58,7 @@ See ``interface/src/tfm_ns_interface.c.example`` for more details.
 
 TF-M provides a reference implementation of NS mailbox on multi-core platforms,
 under folder ``interface/src/multi_core``.
-See :doc:`Mailbox design </docs/technical_references/design_docs/dual-cpu/mailbox_design_on_dual_core_system>`
+See :doc:`Mailbox design </technical_references/design_docs/dual-cpu/mailbox_design_on_dual_core_system>`
 for TF-M multi-core mailbox design.
 
 Interface with non-secure world regression tests
@@ -86,7 +86,7 @@ If SPM manages the NSID (default option), then the same NSID (-1) will be used
 for all connections from NS clients.
 For the case that NSPE RTOS manages the NSID and/or different NSIDs should be
 used for different NS clients. See
-:doc:`Non-secure Client Extension Integration Guide </docs/integration_guide/non-secure_client_extension_integration_guide>`.
+:doc:`Non-secure Client Extension Integration Guide </integration_guide/non-secure_client_extension_integration_guide>`.
 
 *********************
 Non-secure interrupts