| commit | 587e69001f3d885c9b5373701d9debc63c875df0 | [log] [tgz] |
|---|---|---|
| author | Joakim Bech <joakim.bech@linaro.org> | Thu Jan 18 12:27:43 2024 +0100 |
| committer | Joakim Bech <joakim.bech@linaro.org> | Fri Jan 19 09:51:28 2024 +0100 |
| tree | 626a54a1858f18d37af4ef9a06e995ab2f71f8de | |
| parent | a9f89ba02122ebf844bc63a570309c4dcaa3fcdb [diff] |
config: Upgrade Sphinx and dependencies ReadtheDocs now require at least version 5.0 of Sphinx. We've been using 4.5.0 and therefore we needed to upgrade to a more recent version. Sphinx: - Upgrade Sphinx to v7.2.6. - Upgrade all packages and modules needed to the most recent versions as of today. - Replace 'sphinx_panels' (deprecated) with 'sphinx_design'. - Sort the packages and modules alphabetically in the requirements.txt file. Errors: - When doing the upgrade we got multiple errors from the SPMC pages, it looks like the way to refer to an icon has been changed from 'opticon' to 'octicon'. To avoid the error when upgrading, fix this in the same commit. Signed-off-by: Joakim Bech <joakim.bech@linaro.org> Acked-by: Jerome Forissier <jerome.forissier@linaro.org> Acked-by: Jens Wiklander <jens.wiklander@linaro.org>
This is official documentation for the OP-TEE project. Before OP-TEE v3.5.0 it used to be spread across all different OP-TEE gits making up the OP-TEE project as well as optee.org. But starting with OP-TEE v3.5.0 we have gathered all documentation at single place (i.e., this git).
Even though GitHub renders *.rst somewhat OK, you are not suppossed to browse the documentation there/here. Instead you should go to optee.readthedocs.io, where you will find the complete documentation rendered using Sphinx.