doc: Remove per-page contents lists

These are no longer needed as there will always be a table of contents
rendered to the left of every page.

Some of these lists can be quite long and, when opening a page, the
reader sees nothing but a huge list of contents! After this patch,
the document contents are front-and-centre and the contents are
nicely rendered in the sidebar without duplication.

Change-Id: I444754d548ec91d00f2b04e861de8dde8856aa62
Signed-off-by: Paul Beesley <paul.beesley@arm.com>

diff --git a/docs/change-log.rst b/docs/change-log.rst
index 76ec0708278da6b3ecf50364f1f22d218abcb51d..1b6a481f9b1a9c8c48faa4fc9a20e3d84587a955 100644 (file)
--- a/docs/change-log.rst
+++ b/docs/change-log.rst
@@ -4,8 +4,6 @@ Change Log & Release Notes
 This document contains a summary of the new features, changes, fixes and known
 issues in each release of Trusted Firmware-A.
 
-.. contents::
-
 Version 2.1
 -----------
 

diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst
index b370c02fd62cdbfd8bf5271db2079e3ddc3bacc9..2452e06a56273578b094ad8698313ca64ce2f0bd 100644 (file)
--- a/docs/components/exception-handling.rst
+++ b/docs/components/exception-handling.rst
@@ -1,9 +1,6 @@
 Exception Handling Framework
 ============================
 
-.. contents::
-    :depth: 2
-
 .. |EHF| replace:: Exception Handling Framework
 .. |TF-A| replace:: Trusted Firmware-A
 

diff --git a/docs/components/firmware-update.rst b/docs/components/firmware-update.rst
index 8124097a9820871a667393fa4e49fea17066ecd0..608803d57337d03a6131e583d773f9c8b13182a7 100644 (file)
--- a/docs/components/firmware-update.rst
+++ b/docs/components/firmware-update.rst
@@ -1,10 +1,6 @@
 Firmware Update (FWU)
 =====================
 
-.. contents::
-
---------------
-
 Introduction
 ------------
 

diff --git a/docs/components/platform-interrupt-controller-API.rst b/docs/components/platform-interrupt-controller-API.rst
index 5c2293f0902cc950f0a5119593d02e012d2c0364..7890cd38f8f4d5fc25546d310a7cbbf10749be5d 100644 (file)
--- a/docs/components/platform-interrupt-controller-API.rst
+++ b/docs/components/platform-interrupt-controller-API.rst
@@ -1,8 +1,6 @@
 Platform Interrupt Controller API
 =================================
 
-.. contents::
-
 This document lists the optional platform interrupt controller API that
 abstracts the runtime configuration and control of interrupt controller from the
 generic code. The mandatory APIs are described in the `porting guide`__.

diff --git a/docs/components/ras.rst b/docs/components/ras.rst
index 4c16009c45db83dcbd5c352ce9c8f56f0b106a15..9d56e63a5e2d365be97a09632ab33edab81a3726 100644 (file)
--- a/docs/components/ras.rst
+++ b/docs/components/ras.rst
@@ -1,9 +1,6 @@
 Reliability, Availability, and Serviceability (RAS) Extensions
 ==============================================================
 
-.. contents::
-    :depth: 2
-
 .. |EHF| replace:: Exception Handling Framework
 .. |TF-A| replace:: Trusted Firmware-A
 

diff --git a/docs/components/romlib-design.rst b/docs/components/romlib-design.rst
index 00dbf67c85e7a691224ad795432c1b2f07e66d5a..9f62b7c45b2abd57f01d0c59487e5e1eee17a5b8 100644 (file)
--- a/docs/components/romlib-design.rst
+++ b/docs/components/romlib-design.rst
@@ -1,8 +1,6 @@
 Library at ROM
 ==============
 
-.. contents::
-
 This document provides an overview of the "library at ROM" implementation in
 Trusted Firmware-A (TF-A).
 

diff --git a/docs/components/sdei.rst b/docs/components/sdei.rst
index aca1ccb06d7afa8b1eedc5ebd4643254d3231b6b..8c0878976b0dc37de6c6f63157c504a1b32aa0e3 100644 (file)
--- a/docs/components/sdei.rst
+++ b/docs/components/sdei.rst
@@ -1,9 +1,6 @@
 SDEI: Software Delegated Exception Interface
 ============================================
 
-.. contents::
-    :depth: 2
-
 This document provides an overview of the SDEI dispatcher implementation in
 Trusted Firmware-A (TF-A).
 

diff --git a/docs/components/secure-partition-manager-design.rst b/docs/components/secure-partition-manager-design.rst
index 91a135b98c0bcdbfd96531bea9704cec48c4aea4..31276cd76177eda9c3102f94b05104cfdfc9e76c 100644 (file)
--- a/docs/components/secure-partition-manager-design.rst
+++ b/docs/components/secure-partition-manager-design.rst
@@ -1,8 +1,6 @@
 Secure Partition Manager
 ************************
 
-.. contents::
-
 Background
 ==========
 

diff --git a/docs/components/xlat-tables-lib-v2-design.rst b/docs/components/xlat-tables-lib-v2-design.rst
index 26e4f2b9b2726265973cf2888f403a3068377270..a78d35116528759c1b2c71bd5af6c53c028f781d 100644 (file)
--- a/docs/components/xlat-tables-lib-v2-design.rst
+++ b/docs/components/xlat-tables-lib-v2-design.rst
@@ -1,9 +1,6 @@
 Translation (XLAT) Tables Library
 =================================
 
-.. contents::
-
-
 This document describes the design of the translation tables library (version 2)
 used by Trusted Firmware-A (TF-A). This library provides APIs to create page
 tables based on a description of the memory layout, as well as setting up system

diff --git a/docs/design/auth-framework.rst b/docs/design/auth-framework.rst
index dc45127f8e3e9a1a2fcc4a6679131619ddc3da09..49f0def5edc287e434c9413446bb2356c6f35ab8 100644 (file)
--- a/docs/design/auth-framework.rst
+++ b/docs/design/auth-framework.rst
@@ -1,8 +1,6 @@
 Authentication Framework & Chain of Trust
 =========================================
 
-.. contents::
-
 The aim of this document is to describe the authentication framework
 implemented in Trusted Firmware-A (TF-A). This framework fulfills the
 following requirements:

diff --git a/docs/design/cpu-specific-build-macros.rst b/docs/design/cpu-specific-build-macros.rst
index d099ebe26e18f34d53258dbf646f0cb9d6fe7322..e49c73e7b90a4a1cbf3bfd79e1d1d7608f1c22db 100644 (file)
--- a/docs/design/cpu-specific-build-macros.rst
+++ b/docs/design/cpu-specific-build-macros.rst
@@ -1,11 +1,6 @@
 Arm CPU Specific Build Macros
 =============================
 
-
-
-
-.. contents::
-
 This document describes the various build options present in the CPU specific
 operations framework to enable errata workarounds and to enable optimizations
 for a specific CPU on a platform.

diff --git a/docs/design/firmware-design.rst b/docs/design/firmware-design.rst
index d6d7b15301c775759a675b0978fd3c4d1b7eabf1..27d09480af29bec08c307eeec0bcb27207f105da 100644 (file)
--- a/docs/design/firmware-design.rst
+++ b/docs/design/firmware-design.rst
@@ -1,8 +1,6 @@
 Firmware Design
 ===============
 
-.. contents::
-
 Trusted Firmware-A (TF-A) implements a subset of the Trusted Board Boot
 Requirements (TBBR) Platform Design Document (PDD) [1]_ for Arm reference
 platforms. The TBB sequence starts when the platform is powered on and runs up

diff --git a/docs/design/interrupt-framework-design.rst b/docs/design/interrupt-framework-design.rst
index 2a641b1281cb088d0c5a314b399aa74a49b1d991..6f692b2f1ac6ab0da14ddf5e4f79cc605ce5df8a 100644 (file)
--- a/docs/design/interrupt-framework-design.rst
+++ b/docs/design/interrupt-framework-design.rst
@@ -1,8 +1,6 @@
 Interrupt Management Framework 
 ==============================
 
-.. contents::
-
 This framework is responsible for managing interrupts routed to EL3. It also
 allows EL3 software to configure the interrupt routing behavior. Its main
 objective is to implement the following two requirements.

diff --git a/docs/design/psci-pd-tree.rst b/docs/design/psci-pd-tree.rst
index 23c985b6e7102e30c3c97a49818e5280f4cf6874..e52da77c68434b39e84aa448c2260ee9f2bd9f9e 100644 (file)
--- a/docs/design/psci-pd-tree.rst
+++ b/docs/design/psci-pd-tree.rst
@@ -1,10 +1,6 @@
 PSCI Power Domain Tree Structure
 ================================
 
-.. contents::
-
---------------
-
 Requirements
 ------------
 

diff --git a/docs/design/reset-design.rst b/docs/design/reset-design.rst
index 405b4920de1060030e04987c48a3aba93a241704..c38f62748287fca9ca60fd81767f36fbfc0c6a9e 100644 (file)
--- a/docs/design/reset-design.rst
+++ b/docs/design/reset-design.rst
@@ -1,11 +1,6 @@
 CPU Reset
 =========
 
-
-
-
-.. contents::
-
 This document describes the high-level design of the framework to handle CPU
 resets in Trusted Firmware-A (TF-A). It also describes how the platform
 integrator can tailor this code to the system configuration to some extent,

diff --git a/docs/design/trusted-board-boot.rst b/docs/design/trusted-board-boot.rst
index 76badb623cf74b33747da40bff53dff1d69b6731..dbe2f2aa4fd9027865fb4dc1a78ef6a9d236b6ab 100644 (file)
--- a/docs/design/trusted-board-boot.rst
+++ b/docs/design/trusted-board-boot.rst
@@ -1,11 +1,6 @@
 Trusted Board Boot
 ==================
 
-
-
-
-.. contents::
-
 The Trusted Board Boot (TBB) feature prevents malicious firmware from running on
 the platform by authenticating all firmware images up to and including the
 normal world bootloader. It does this by establishing a Chain of Trust using

diff --git a/docs/getting_started/image-terminology.rst b/docs/getting_started/image-terminology.rst
index 10aebf5e4f1f6fce64790ff94918cddf263b47da..d9e08f76cdd27ddb3066341cd93d44ff33d82826 100644 (file)
--- a/docs/getting_started/image-terminology.rst
+++ b/docs/getting_started/image-terminology.rst
@@ -1,8 +1,6 @@
 Image Terminology
 =================
 
-.. contents::
-
 This page contains the current name, abbreviated name and purpose of the various
 images referred to in the Trusted Firmware project.
 

diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst
index f0728433337d5d9077aef727fbc9d0c68bb96ab1..458615ec3d48c794b1b40b836b4deb4095af74b7 100644 (file)
--- a/docs/getting_started/porting-guide.rst
+++ b/docs/getting_started/porting-guide.rst
@@ -1,8 +1,6 @@
 Porting Guide
 =============
 
-.. contents::
-
 Introduction
 ------------
 

diff --git a/docs/getting_started/psci-lib-integration-guide.rst b/docs/getting_started/psci-lib-integration-guide.rst
index c8cf3f3932fc9aa61163be8af820cebf70e19180..f5ea0d78b74b36dd932b05891d8a718e167ca702 100644 (file)
--- a/docs/getting_started/psci-lib-integration-guide.rst
+++ b/docs/getting_started/psci-lib-integration-guide.rst
@@ -1,10 +1,6 @@
 PSCI Library Integration guide for Armv8-A AArch32 systems
 ==========================================================
 
-
-
-.. contents::
-
 This document describes the PSCI library interface with a focus on how to
 integrate with a suitable Trusted OS for an Armv8-A AArch32 system. The PSCI
 Library implements the PSCI Standard as described in `PSCI spec`_ and is meant

diff --git a/docs/getting_started/rt-svc-writers-guide.rst b/docs/getting_started/rt-svc-writers-guide.rst
index 35948b5478dc06b0f3090844927146ca637d4d29..559d701a388e8e67b55a1ff009538420dba8c9e5 100644 (file)
--- a/docs/getting_started/rt-svc-writers-guide.rst
+++ b/docs/getting_started/rt-svc-writers-guide.rst
@@ -1,10 +1,6 @@
 EL3 Runtime Service Writer's Guide
 =====================================================
 
-
-
-.. contents::
-
 Introduction
 ------------
 

diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst
index 894313a7fe48482465064a53c271fd01dfe44b4b..a4aa1a791a351b47c2332fce10212a3d0ec9d819 100644 (file)
--- a/docs/getting_started/user-guide.rst
+++ b/docs/getting_started/user-guide.rst
@@ -1,8 +1,6 @@
 User Guide
 ==========
 
-.. contents::
-
 This document describes how to build Trusted Firmware-A (TF-A) and run it with a
 tested set of other software components using defined configurations on the Juno
 Arm development platform and Arm Fixed Virtual Platform (FVP) models. It is

diff --git a/docs/index.rst b/docs/index.rst
index b0348f165ec822151b79d4cd12d34ceeb04cd1a6..f23b948d04aaea1e21c4c26d43c38d19bba743cc 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,7 +3,7 @@ Trusted Firmware-A Documentation
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contents
+   :hidden:
 
    Home<self>
    getting_started/index
@@ -18,6 +18,9 @@ Trusted Firmware-A Documentation
    maintainers
    license
 
+.. contents:: On This Page
+    :depth: 3
+
 Trusted Firmware-A (TF-A) provides a reference implementation of secure world
 software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing
 at Exception Level 3 (EL3). It implements various Arm interface standards,

diff --git a/docs/plat/rpi3.rst b/docs/plat/rpi3.rst
index f8b59b52fa78bff41c85596cb9d5921b30f2d37f..d155fcbfb845ca73a1cf9fd289bd6397287bb270 100644 (file)
--- a/docs/plat/rpi3.rst
+++ b/docs/plat/rpi3.rst
@@ -1,8 +1,6 @@
 Raspberry Pi 3
 ==============
 
-.. contents::
-
 The `Raspberry Pi 3`_ is an inexpensive single-board computer that contains four
 Arm Cortex-A53 cores.
 

diff --git a/docs/process/coding-guidelines.rst b/docs/process/coding-guidelines.rst
index def5bf991d249a33febab282e8b2a1b2e23b1744..856882b5f00edcf7f2e6914e5d587f513f100226 100644 (file)
--- a/docs/process/coding-guidelines.rst
+++ b/docs/process/coding-guidelines.rst
@@ -1,8 +1,6 @@
 Coding Style & Guidelines
 =========================
 
-.. contents::
-
 The following sections contain TF coding guidelines. They are continually
 evolving and should not be considered "set in stone". Feel free to question them
 and provide feedback.

diff --git a/docs/process/platform-compatibility-policy.rst b/docs/process/platform-compatibility-policy.rst
index 47b0e7e96712d584b1f4ecc6408616eba3cf6176..1c80eb5626ae08909a4346dd73a0f9851f48b9de 100644 (file)
--- a/docs/process/platform-compatibility-policy.rst
+++ b/docs/process/platform-compatibility-policy.rst
@@ -1,13 +1,6 @@
 Platform Compatibility Policy
 =============================
 
-
-
-
-.. contents::
-
---------------
-
 Introduction
 ------------
 

diff --git a/docs/process/release-information.rst b/docs/process/release-information.rst
index 89c19ab2ab20bd3e923c13853feea341e7693a96..b81d42d59ca717e8cfa8711eae5d3f5c79f5b918 100644 (file)
--- a/docs/process/release-information.rst
+++ b/docs/process/release-information.rst
@@ -1,10 +1,6 @@
 Release Processes
 =================
 
-.. contents::
-
---------------
-
 Project Release Cadence
 -----------------------