aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Wang <david.wang@arm.com>2021-06-21 17:17:26 +0800
committerKen Liu <ken.liu@arm.com>2021-06-22 03:08:49 +0200
commitd6fd6af18067f7bf229a86686cd499e80886db78 (patch)
tree747a445eaa3f11d21957bb8907c787f95f56e4e3 /docs
parented119d4a89861494d084cd0add30f57b5ccc0221 (diff)
downloadtrusted-firmware-m-d6fd6af18067f7bf229a86686cd499e80886db78.tar.gz
Docs: Fix the broken links in the documentation
Sphinx uses "autosectionlable" extension for generating the section labels automatically. The max depth is set to 2 for level 2 headers only. That section which is under level 2 will not have the reference label. This caused the broken links in the documentation. This patch creates lables for the section which is under level 2 and referenced by other places in the documentation. Signed-off-by: David Wang <david.wang@arm.com> Change-Id: I636922c624108e850635e683719f5ac035e0880b
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started/tfm_sw_requirement.rst4
-rw-r--r--docs/integration_guide/SQUAD_Dashboard.rst2
-rw-r--r--docs/technical_references/instructions/tfm_build_instruction.rst4
3 files changed, 7 insertions, 3 deletions
diff --git a/docs/getting_started/tfm_sw_requirement.rst b/docs/getting_started/tfm_sw_requirement.rst
index c37750d375..71972599a2 100644
--- a/docs/getting_started/tfm_sw_requirement.rst
+++ b/docs/getting_started/tfm_sw_requirement.rst
@@ -150,7 +150,7 @@ Download and install the required tools:
curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
Clone the TF-M Sources
-(see :ref:`docs/technical_references/instructions/tfm_build_instruction:Getting the source-code`),
+(see :ref:`Getting the source-code`),
then
.. code-block:: bash
@@ -241,7 +241,7 @@ Tools required to generate documentation:
Download and install the required tools from above.
Clone the TF-M Sources
-(see :ref:`docs/technical_references/instructions/tfm_build_instruction:Getting the source-code`),
+(see :ref:`Getting the source-code`),
then
.. code-block:: bash
diff --git a/docs/integration_guide/SQUAD_Dashboard.rst b/docs/integration_guide/SQUAD_Dashboard.rst
index 5da74a0310..ac720e0fb8 100644
--- a/docs/integration_guide/SQUAD_Dashboard.rst
+++ b/docs/integration_guide/SQUAD_Dashboard.rst
@@ -49,7 +49,7 @@ used. The configurations available currently are the following :
For all of the configurations, tests are disabled and the release build type is
used. For more details about the configurations and how the rest of the options
are set for each of them, see
-:ref:`docs/technical_references/instructions/tfm_build_instruction:Migration from legacy buildsystem`.
+:ref:`Migration from legacy buildsystem`.
More configurations and metrics could be added to the dashboard in the future.
For each metric sent to the SQUAD dashboard, the metric must be linked with the
diff --git a/docs/technical_references/instructions/tfm_build_instruction.rst b/docs/technical_references/instructions/tfm_build_instruction.rst
index 485d917ca2..e2dc85dd8f 100644
--- a/docs/technical_references/instructions/tfm_build_instruction.rst
+++ b/docs/technical_references/instructions/tfm_build_instruction.rst
@@ -12,6 +12,8 @@ build environment. The instructions are below.
Cmake version ``3.15.0`` or higher is required.
+.. _Getting the source-code:
+
Getting the source-code
=======================
.. code-block:: bash
@@ -190,6 +192,8 @@ The Firmware Framework test suites are:
Note that these map directly to the ``SUITE`` cmake variable used in the
psa-arch-tests documentation.
+.. _Migration from legacy buildsystem:
+
Migration from legacy buildsystem
---------------------------------