aboutsummaryrefslogtreecommitdiffstats
path: root/docs/components/index.rst
diff options
context:
space:
mode:
authorPaul Beesley <paul.beesley@arm.com>2019-02-11 17:54:45 +0000
committerPaul Beesley <paul.beesley@arm.com>2019-05-21 15:05:56 +0100
commit40d553cfde38d4f68449c62967cd1ce0d6478750 (patch)
tree1fafd4701066cdf0e5fb15aee2d842279a67b611 /docs/components/index.rst
parent12b67439e93a78a4b756e987e1bd1b6e22cc4bf8 (diff)
downloadplatform_external_arm-trusted-firmware-40d553cfde38d4f68449c62967cd1ce0d6478750.tar.gz
platform_external_arm-trusted-firmware-40d553cfde38d4f68449c62967cd1ce0d6478750.tar.bz2
platform_external_arm-trusted-firmware-40d553cfde38d4f68449c62967cd1ce0d6478750.zip
doc: Move documents into subdirectories
This change creates the following directories under docs/ in order to provide a grouping for the content: - components - design - getting_started - perf - process In each of these directories an index.rst file is created and this serves as an index / landing page for each of the groups when the pages are compiled. Proper layout of the top-level table of contents relies on this directory/index structure. Without this patch it is possible to build the documents correctly with Sphinx but the output looks messy because there is no overall hierarchy. Change-Id: I3c9f4443ec98571a56a6edf775f2c8d74d7f429f Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/components/index.rst')
-rw-r--r--docs/components/index.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/components/index.rst b/docs/components/index.rst
new file mode 100644
index 000000000..f1904c004
--- /dev/null
+++ b/docs/components/index.rst
@@ -0,0 +1,18 @@
+Components
+==========
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Contents
+ :numbered:
+
+ spd/index
+ arm-sip-service
+ exception-handling
+ firmware-update
+ platform-interrupt-controller-API
+ ras
+ romlib-design
+ sdei
+ secure-partition-manager-design
+ xlat-tables-lib-v2-design