+
+ +
+

Building the documentation

+

The documentation is under the “docs” folder, and is written in reStructuredText format. Documentation in HTML format +is pre-generated, as well as code documentation, and this can be done automatically via a provided script.

+
+

Requirements

+

To build the documentation, you will need:

+ +

The Dokka JAR file is expected to be placed under the “lib” directory, called:

+
lib/dokka.jar
+
+
+

Note that to install under OS X El Capitan, you will need to tell pip to install under /usr/local, for example:

+
sudo -H pip install --install-option '--install-data=/usr/local' Sphinx
+sudo -H pip install --install-option '--install-data=/usr/local' sphinx_rtd_theme
+
+
+
+
+

Build

+

Once the requirements are installed, you can manually build the documentation by changing to the “docs” folder, and +running make, for example to produce the documentation in HTML format:

+
make html
+
+
+

If you type “make” by itself, it will list the possible build targets (formats).

+

Alternatively, the full documentation in HTML format, as well as the API documentation can be built by running the +following script:

+
scripts/generate-docsite.sh
+
+
+
+
+ + +
+