Building the Documentation

This contains the steps to build the documentation

API Reference

The API reference is built using Dokka and most of the things to set up are already handled in Gradle. To build the documentation, run the command below.

./gradlew dokkaHtml

This should create the API reference documentation in docs/api.

Other Documentation

The other pages in the documentation is generated using MkDocs. To run it, a working Python installation is required.

Installing Python Dependencies

A requirements.txt file is provided to install all the Python dependencies to build the documentation, run the command below.

pip install -r requirements.txt

Running the Development Server

To check if the documentations work fine or to edit and see the results immediately, a test server can serve the documentation. To do this, run the command below.

mkdocs serve

Building the Documentation

The documentation can be build using the commands below. If the directory is not specified, the documentation is saved in sites/

mkdocs build

mkdocs build -d $TARGET_PATH