| commit | 8e5c5b3ed23794bd043addde818f764a0dc86102 | [log] [tgz] |
|---|---|---|
| author | Joakim Bech <joakim.bech@linaro.org> | Thu Oct 25 08:18:32 2018 +0200 |
| committer | Joakim Bech <joakim.bech@linaro.org> | Thu Feb 21 10:19:10 2019 +0100 |
| tree | 1ebafa982ef63c1318979068d9ac500b685e7a61 |
Initial commit for the official OP-TEE documentation This initial commit brings in all existing documentation found across various gits making up the documentation for the OP-TEE project. So in summary what this includes and what has been done is: - Import all old documentation (optee_os, optee_client, optee_test and so on). - Convert everything from markdown (*.md) to reStructuredText (*.rst). - Add a couple of new pages (optee_docs, disclosure policy to name a few). - Add Sphinx configuration. - Add Travis configuration to enable automatic testing of future documentation patches. - Finally, a general clean-up and verification of content, links as well as verification of build instructions etc has also been done.
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.
