Merge "fix(docs): ensure all submodules are cloned" into integration

fix(docs): ensure all submodules are cloned

`TLC`, which is part of `LibTL`, is consumed via a Git submodule. Its
presence is required when running `poetry install`. Ensure that all
submodules are i

fix(docs): ensure all submodules are cloned

`TLC`, which is part of `LibTL`, is consumed via a Git submodule. Its
presence is required when running `poetry install`. Ensure that all
submodules are initialized and updated by explicitly configuring
RTD to fetch submodules recursively prior to installation.

Change-Id: I49e2911473240cb6cbd72234d3a186d077dc307f
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>

show more ...

Merge "refactor(memmap): migrate to Poetry" into integration

refactor(memmap): migrate to Poetry

This change refactors the memmap tool into a Poetry project, with its
own dependencies. You can continue to run it manually with:

poetry run memory <args>

C

refactor(memmap): migrate to Poetry

This change refactors the memmap tool into a Poetry project, with its
own dependencies. You can continue to run it manually with:

poetry run memory <args>

Change-Id: I346283df1b8bfad4babc1f5a3861dab94d4a006a
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

Merge "fix(docs): point poetry readthedocs virtual env" into integration

fix(docs): point poetry readthedocs virtual env

RTD uses a mixture of poetry and pip to install packages in the build
environment. In the past it was recommended to disable poetry from
creating a fr

fix(docs): point poetry readthedocs virtual env

RTD uses a mixture of poetry and pip to install packages in the build
environment. In the past it was recommended to disable poetry from
creating a fresh virtual environment. Instead, the expectation was that
poetry would be able to detect it's current virtual environment and
install the packages in the right place. This was recently updated to
allow poetry to better allow dependcy management by poetry [1]. Remove
this configuration and explicitly point Poetry to the virtual
environment.

[1] https://github.com/readthedocs/readthedocs.org/pull/11152

Change-Id: I58e49ba6f6d122e70bbcf1dbb10220881a09faf3
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>

show more ...

Merge "fix: use rsvg-convert as the conversion backend" into integration

fix: use rsvg-convert as the conversion backend

The auxiliary pdf build requires SVG files to be converted to pdf files.
Use libRSVG as a light weight alternative to inkscape, and ensure it's
instal

fix: use rsvg-convert as the conversion backend

The auxiliary pdf build requires SVG files to be converted to pdf files.
Use libRSVG as a light weight alternative to inkscape, and ensure it's
installed in the build environment.

Change-Id: I1fdb05fb2701fc28a04e210d5928f4387ca08613
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>

show more ...

Merge "Revert "docs: disable PDF output for documentation generation"" into integration

Revert "docs: disable PDF output for documentation generation"

This reverts commit 279e28ed3526bfcfb8d8bc736e4f5aafd3d73ba3.

Reason for revert: Re-enable the pdf generation since the necessary fix

Revert "docs: disable PDF output for documentation generation"

This reverts commit 279e28ed3526bfcfb8d8bc736e4f5aafd3d73ba3.

Reason for revert: Re-enable the pdf generation since the necessary fix to generate pdf has already been merged.

Change-Id: Ia68e8caea94b5d89fcf182251a13473b32b4bfad

show more ...

Merge "fix: pin poetry to version used in CI" into integration

fix: pin poetry to version used in CI

Pin poetry to version 1.3.2, which is currently used in CI, to ensure
that all builds are consistent. Also, fix typo in `doc` group name.

Change-Id: Id0c1aa88a

fix: pin poetry to version used in CI

Pin poetry to version 1.3.2, which is currently used in CI, to ensure
that all builds are consistent. Also, fix typo in `doc` group name.

Change-Id: Id0c1aa88ac7ffcc241a51c693570e87abacf7ebc
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>

show more ...

Merge "feat: add support for poetry" into integration

feat: add support for poetry

New python dependencies are introduced by the memory mapping script.
Rather than add another `requirements.txt` utilise poetry. This is a
proper dependency management fr

feat: add support for poetry

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>

show more ...

Merge "docs: disable PDF output for documentation generation" into integration

docs: disable PDF output for documentation generation

Change-Id: I827deeb8008f0bf5f44c1f9d4afcce21ef102bba

Merge "fix(docs): add plantuml as a dependency" into integration

fix(docs): add plantuml as a dependency

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 Karatot

fix(docs): add plantuml as a dependency

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

show more ...

Merge "fix(docs): python version must be string" into integration

fix(docs): python version must be string

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
Change-Id: If5886f8adb391edf3771112cd8e20957a454eae0

Merge "fix(docs): specify python version to 3.10" into integration

fix(docs): specify python version to 3.10

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: I73530750065

fix(docs): specify python version to 3.10

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

show more ...

Merge "fix(docs): add a build.tools.python entry" into integration

fix(docs): add a build.tools.python entry

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: Bo

fix(docs): add a build.tools.python entry

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

show more ...

Merge "fix(docs): add readthedocs configuration file" into integration