summaryrefslogtreecommitdiff
path: root/docs/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* fix(docs): prevent a sphinx warningBoyan Karatotev2022-11-161-1/+1
| | | | | | | | | Some newer versions of sphinx (tried on v5.3) will warn about language being None which will fail the build. Change it to the default (en) to prevent this. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: Ie0570481f42aeb293e885ca936e0765f6cb299a8
* fix(docs): prevent a virtual environment from failing a buildBoyan Karatotev2022-11-161-1/+2
| | | | | | | | | | | | sphinx-build is passed a blanket "." to build all docs. However, if a virtual environment is placed within the docs directory, sphinx will try to build it which will fail due to some weird files it has. This excludes the most common virtual environment directories from the build to prevent this. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: Ieeb14cfc5730d21c986611feb0ed379c58dfcae2
* build(docs): add support for Markdown documentationChris Kay2021-11-171-2/+2
| | | | | | | | | | | | This changes adds support for building Markdown documentation into Sphinx with [MyST]. We'll make use of this in a later patch, where we introduce automatically-generated Markdown documentation that needs to be compiled as part of the Sphinx documentation. [MyST]: https://myst-parser.readthedocs.io/en/latest Change-Id: I2a241a588c579fac1a81e1853479908928be1fc8 Signed-off-by: Chris Kay <chris.kay@arm.com>
* docs(threat model): add TF-A threat modelZelalem2021-04-301-1/+9
| | | | | | | | | | | This is the first release of the public Trusted Firmware A class threat model. This release provides the baseline for future updates to be applied as required by developments to the TF-A code base. Signed-off-by: Zelalem Aweke <zelalem.aweke@arm.com> Change-Id: I3c9aadc46196837679f0b1377bec9ed4fc42ff11
* doc: Remove version and release variables from conf.pyPaul Beesley2019-10-171-3/+0
| | | | | | | | | | | | | We would need to update this version for the release but, in fact, it is not required for our publishing workflow; the hosted version of the docs uses git commit/tag information in place of these variables anyway. Instead of updating the version, just remove these variables entirely. Change-Id: I424c4e45786e87604e91c7197b7983579afe4806 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Generate PlantUML diagrams automaticallyPaul Beesley2019-07-121-2/+6
| | | | | | | | | | | | | | | | | | | 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>
* doc: Enable automatic labels for page titlesPaul Beesley2019-05-301-1/+9
| | | | | | | | | | | | | | | | 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: Paul Beesley <paul.beesley@arm.com>
* doc: Add minimal glossaryPaul Beesley2019-05-221-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One of the current issues with the documentation is that terms and abbreviations are frequently redefined. For example, we might have a sentence like "... the SCP (System Control Processor) will ...". These definitions might be repeated several times across pages, or even within the same document. Equally, some of these abbreviations are missed and are never expanded. Sphinx provides a :term: keyword that takes some text and, if that text is defined in a glossary document, links to its glossary entry. Using this functionality will prevent repeated definitions and will make the docs more maintainable by using a single definition source. The glossary added in this patch was created from a quick scrub of the source code - there may be missing entries. The SDEI abbreviation was used as an example. Note that a global_substitutions file was created. This file contains the RST 'replace' statements that convert plain text terms into linked terms (by adding the ':term:' keyword to them). An example is: .. |TF-A| replace:: :term:`TF-A` The 'rst_prolog' variable in conf.py is used to inject this list of replacements into each page. Terms must be surrounded with the pipe character to be turned into links - this means that we can still prevent certain terms from being linked if we don't want them to be. Change-Id: I87010ed9cfa4a60011a9b4a431b98cb4bb7baa28 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
* doc: Add minimal Sphinx supportPaul Beesley2019-05-211-0/+72
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>
View Lorry Controller Status