Building documentation

The documentation for OpenTitan is available online. The creation of documentation is mainly based around the conversion from Markdown to HTML files with mdbook. Rules for how to write correct Markdown files can be found in the reference manual.

Building locally

There are a few project specific preprocessors. These preprocessors require the installation of the dependencies outlined in the previous section. util/site/ handles building all books in the repository and other auto-generated content, such as the API documentation generated by Doxygen.

Running the server

In order to run a local instance of the documentation server run the following command from the root of the project repository.

./util/site/ serve

This will execute the preprocessing, build the documentation and finally start a local server. The output will indicate at which address the local instance can be accessed. The default is