1. 22 May, 2019 1 commit
    • Paul Beesley's avatar
      doc: Reword document titles · 8aa05055
      Paul Beesley authored
      
      
      This patch attempts to standardise the document titles as well as
      adding titles to documents that were missing one. The aim is to
      remove needless references to "TF-A" or "Trusted Firmware" in the
      title of every document and to make sure that the title matches
      with the document content.
      
      Change-Id: I9b93ccf43b5d57e8dc793a5311b8ed7c4dd245cc
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
      8aa05055
  2. 21 May, 2019 3 commits
    • Paul Beesley's avatar
      doc: Move content out of readme and create new index page · 9f1622b0
      Paul Beesley authored
      
      
      Previously the readme.rst file served as the entrypoint for the
      documentation. With a Sphinx build the top-level document is set
      to be index.rst as it contains the primary document index.
      
      This patch moves some content from readme.rst into index.rst and
      splits the license information out into license.rst.
      
      Change-Id: I5c50250b81136fe36aa9ceedaae302b44ec11e47
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
      9f1622b0
    • Paul Beesley's avatar
      doc: Move documents into subdirectories · 40d553cf
      Paul Beesley authored
      
      
      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: default avatarPaul Beesley <paul.beesley@arm.com>
      40d553cf
    • Paul Beesley's avatar
      doc: Add minimal Sphinx support · 653279b0
      Paul Beesley authored
      
      
      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: default avatarPaul Beesley <paul.beesley@arm.com>
      653279b0