Building the Documentation

This document conatins the steps to build the documentation. The documentation build process is operated using GNU Make. To build the entire documentation, run make from the project folder. The documentation will be built as a static web project in the ./site folder (which is created if it doesn't exist). To test it out, just start a static http-server in that folder

cd ./site
python -m http.server

Note: Since the iOS API-reference is built using xcode, you need to use a Mac in order to build the entire documentation.

API Reference

The API Reference is built using DocC, Apples official documentation framework. Since this documentation is built using xcode, a Mac is required to build it. To build the api documentation there is a make rule called api-docs. This rule generates the API documentation and stores it in the ./site/api folder. If that folder does not exist, the make rule with fail with an error.

Other Documentation

Apart from the API Reference, there's also some other documentation included in the document (e.g. this page that you are currently reading). These pages are built using MkDocs which automatically converts a folder with markdown (and html) pages into a web page, using some user-defined settings. All of the source material for these documents are located in the ./docs folder.

When writing documentation you can start a debug mode with mkdocs which automatically reloads the documentation as soon as it detects a change in the ./docs folder. To start that mode, run make docs-debug from the project folder.

Creating new Pages

In order to create new pages, open the mkdocs.yml and create a new entry in the nav section, with the entry written in the format - Title: path. Then, create a new markdown file with path you added. Refer to the official MkDocs User Guide for more information.