1. 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
  2. 30 May, 2019 1 commit
    • Paul Beesley's avatar
      doc: Enable automatic labels for page titles · c4e4df35
      Paul Beesley authored
      
      
      Automatic labelling of document titles is a prerequisite for
      converting the format of cross-document links. Sphinx will
      generate (via the enabled extension) a hidden link target for
      each document title and this can be referred to later, from
      another page, to link to the target.
      
      The plugin options being used require Sphinx >= 2.0.0 so a
      requirements.txt file has been added. This file is used with
      the pip package manager for Python so that the correct
      dependencies are installed.
      
      Change-Id: Ic2049db5804aa4a6447608ba4299de958ce0a87d
      Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
      c4e4df35