1. 26 Jun, 2020 1 commit
  2. 01 Apr, 2020 1 commit
  3. 11 Mar, 2020 1 commit
  4. 07 Feb, 2020 1 commit
  5. 28 Oct, 2019 1 commit
    • Sandrine Bailleux's avatar
      doc: Fix syntax erros in I/O storage layer plantuml diagrams · ec477e7d
      Sandrine Bailleux authored
      Some of the plantuml diagrams in the I/O storage abstraction layer
      documentation are absent from the rendered version of the porting
      guide. The build log (see [1] for example) reports a syntax error in
      these files. This is due to the usage of the 'order' keyword on the
      participants list, which does not seem to be supported by the version
      of plantuml installed on the ReadTheDocs server.
      
      Fix these syntax errors by removing the 'order' keyword altogether. We
      simply rely on the participants being declared in the desired order,
      which will be the order of display, according to the plantuml
      documentation.
      
      [1] https://readthedocs.org/api/v2/build/9870345.txt
      
      
      
      Change-Id: Ife35c74cb2f1dac28bda07df395244639a8d6a2b
      Signed-off-by: default avatarSandrine Bailleux <sandrine.bailleux@arm.com>
      ec477e7d
  6. 18 Jul, 2019 1 commit
  7. 12 Jul, 2019 1 commit
    • Paul Beesley's avatar
      doc: Generate PlantUML diagrams automatically · 7cb68807
      Paul Beesley authored
      
      
      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: default avatarPaul Beesley <paul.beesley@arm.com>
      7cb68807
  8. 10 Jul, 2019 1 commit
  9. 22 May, 2019 1 commit
  10. 21 May, 2019 1 commit
    • 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