summaryrefslogtreecommitdiff
path: root/docs/resources
AgeCommit message (Collapse)Author
2019-07-18doc: Complete the storage abstraction layer docLouis Mayencourt
Add uml sequence and class diagram to illustrate the behavior of the storage abstraction layer. Change-Id: I338262729f8034cc3d3eea1d0ce19cca973a91bb Signed-off-by: Louis Mayencourt <louis.mayencourt@arm.com>
2019-07-12doc: Generate PlantUML diagrams automaticallyPaul Beesley
Currently we have some pre-rendered versions of certain diagrams in SVG format. These diagrams have corresponding PlantUML source that can be rendered automatically as part of the documentation build, removing the need for any intermediate files. This patch adds the Sphinx "plantuml" extension, replaces references to the pre-rendered SVG files within the documents, and finally removes the SVG files and helper script. New requirements for building the docs are the "sphinxcontrib-plantuml" Python module (added to the pip requirements.txt file) and the Graphviz package (provides the "dot" binary) which is in the Ubuntu package repositories. Change-Id: I24b52ee40ff79676212ed7cff350294945f1b50d Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-07-10Remove references to old project name from common filesJohn Tsichritzis
The project has been renamed from "Arm Trusted Firmware (ATF)" to "Trusted Firmware-A (TF-A)" long ago. A few references to the old project name that still remained in various places have now been removed. This change doesn't affect any platform files. Any "ATF" references inside platform files, still remain. Change-Id: Id97895faa5b1845e851d4d50f5750de7a55bf99e Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
2019-05-22doc: Reorganise images and update linksPaul Beesley
Change-Id: I679d1499376a524bef1cfc33df995b0a719b5ac8 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-05-21doc: Add minimal Sphinx supportPaul Beesley
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>