This is the Git where all official OP-TEE documentation resides and this is what
you are reading right now. Here we will give instructions on how to write and
build the documentation as well as give some guidelines on what to do and not to
do. Note that the documentation is written for Sphinx. So, even though GitHub
for example renders
*.rst files somewhat OK, that is still not the preferred
way to read and view the documentation. Instead head over to
https://optee.readthedocs.io where the final output is stored and nicely
rendered using Sphinx.
Before doing anything else, first install Sphinx and the dependencies.
$ sudo apt install graphviz python3-sphinx python3-sphinx-rtd-theme
$ git clone https://github.com/OP-TEE/optee_docs
$ cd optee_docs
$ make html
After this step all documentation should have been built and you can open
<optee_docs>/_build/html/index.html in your browser to see the result and
browse the documentation.
By using a Linux tool called
entr. You can automatically rebuild the
pages your are working with. First get the package
$ sudo apt install
$ cd <optee_docs>
$ find . -name "*.rst" | entr -c make html
entr will automatically rebuild the documentation everytime
you make change and save a file. Which means you only have to save the file
in your editor and refresh the browser page to see the changes locally.