Skip to content

README-dev.md

Latest commit

 

History

History
25 lines (15 loc) · 900 Bytes

README-dev.md

File metadata and controls

25 lines (15 loc) · 900 Bytes

Building the docs

Prerequisites

To build the documentation of this project, you need a UNIX-based operating system. Windows is not fully supported as it does not support symlinks.

You also need the following software installed doxygen to generate the reference documentation of the driver. You can install it using the following command:

Ubuntu

sudo apt-get install doxygen

MacOS

brew install doxygen

Once you have installed the above software, you can build and preview the documentation by following the steps outlined in the Quickstart guide.

Custom commands

To generate the reference documentation of the driver, run the command make javadoc. This command generates the reference documentation using the Javadoc tool in the _build/dirhtml/<VERSION>/api directory.