TRUST documentation on GitHub & Read the Docs !

Hi there 👋 and welcome to the TRUST Documentation page!

To build locally the website, follow the following steps:

• First, clone this repository:

git clone https://github.com/cea-trust-platform/trust-documentation.git ./trust_documentation

• Install the needed dependecies:

cd trust_documentation/doc
pip install -r requirements.txt

Then you can build the documentation:

 ./build_documentation

The documentation uses a MyST parser. You can therefore use .rst and .md files.

You might need to clean your project if you do a massive change:

cd trust_documentation/doc
make clean && make html

Credits for the open-source Sphinx Book Theme, Doxygen Awesome Theme, Read The Docs projects and MyST parser.

Enjoy TRUST 🍻🍻 !!