summaryrefslogtreecommitdiff
path: root/.readthedocs.yaml
Commit message (Collapse)AuthorAgeFilesLines
* feat: add support for poetryHarrison Mutai2023-04-191-4/+6
| | | | | | | | | | | | | | | | | | New python dependencies are introduced by the memory mapping script. Rather than add another `requirements.txt` utilise poetry. This is a proper dependency management framework for Python. The two main upsides of using poetry instead of the traditional requirements.txt are maintainability and reproducibility. Poetry provides a proper lock file for pinning dependencies, similar to npm for JavaScript. This allows for separate environments (i.e. docs, tools) to be created efficiently, and in a reproducible manner, wherever the project is deployed. Having dependencies pinned in this manner is a boon as a security focused project. An additional upside is that we will receive security updates for dependencies via GitHub's Dependabot. Change-Id: I5a3c2003769b878a464c8feac0f789e5ecf8d56c Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
* docs: disable PDF output for documentation generationSandrine Bailleux2023-03-161-5/+0
| | | | Change-Id: I827deeb8008f0bf5f44c1f9d4afcce21ef102bba
* fix(docs): add plantuml as a dependencyBoyan Karatotev2023-02-271-0/+2
| | | | | | | | This wasn't listed on the web interface configuration. Perhaps it came preloaded. Anyway, it's needed for diagrams. Add it back. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: I20c1eb0e8d5abaa3533169dd9704cbd3b0eb06a5
* fix(docs): python version must be stringBoyan Karatotev2023-02-161-1/+1
| | | | | Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: If5886f8adb391edf3771112cd8e20957a454eae0
* fix(docs): specify python version to 3.10Boyan Karatotev2023-02-161-1/+1
| | | | | | | | The docs say 3 is valid, but it is not. Jammy uses 3.10 so pin it to that. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: I73530750065294eb511d88318ba86a6c50c8aa7d
* fix(docs): add a build.tools.python entryBoyan Karatotev2023-02-161-0/+2
| | | | | | | | Specifying build.tools is mandatory. We use python, so use the latest one available. For ubuntu 22.04 that should be 3.10 or thereabouts. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: Ifd184b9f3b2d8e91182ccb73c47b148e4aeaff05
* fix(docs): add readthedocs configuration fileBoyan Karatotev2023-02-161-0/+25
Readthedocs uses weird defaults and the web interface gives limited configuration options. Add the config file to allow them to be changed. Bump build os image to Ubuntu 22.04 to be in line with the CI. Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: I1a620b15ab3924244f305056096024fe117c63dd