Skip to content

Latest commit

 

History

History
16 lines (9 loc) · 777 Bytes

README-dev.md

File metadata and controls

16 lines (9 loc) · 777 Bytes
Raw

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 to generate the reference documentation of the driver:

  • Java JDK 8 or higher
  • Maven

Once you have installed the above software, you can build and preview the documentation by following the steps outlined in the Quickstart guide <https://sphinx-theme.scylladb.com/stable/getting-started/quickstart.html>_.

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.