diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-01-23 15:39:39 +0000 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-05-21 12:31:25 +0100 |
| commit | 653279b015080969eaf4ac85b1e3a31965666550 (patch) | |
| tree | d46efda6c87398b1c92916383da140bf172c53a8 /docs/index.rst | |
| parent | b189a206137322cbfe134731dba90a7455452ab4 (diff) | |
doc: Add minimal Sphinx support
Add the essentials for supporting a Sphinx documentation build:
- A makefile under docs/ to invoke Sphinx with the desired output
format
- A Sphinx master configuration file (conf.py)
- A single, top-level index page (index.rst)
- The TF.org logo that is integrated in the the sidebar of the
rendered output
Change-Id: I85e67e939658638337ca7972936a354878083a25
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..a6c1ca92 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +Arm Trusted Firmware-A Documentation Index +========================================== + +.. toctree:: + :maxdepth: 1 + :caption: Design Documents + + arm-sip-service + auth-framework + + .. toctree:: + :maxdepth: 1 + :caption: Release Notes + change-log + + .. toctree:: + :maxdepth: 1 + :caption: Guides + + .. toctree:: + :maxdepth: 1 + :caption: Policies + cpu-specific-build-macros + exception-handling + firmware-design + firmware-update + interrupt-framework-design + platform-compatibility-policy + platform-interrupt-controller-API + porting-guide + psci-lib-integration-guide + psci-pd-tree + ras + reset-design + rt-svc-writers-guide + sdei + secure-partition-manager-design + trusted-board-boot + user-guide + xlat-tables-lib-v2-design + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |