Building the Documentation

This page describes how to build this documentation.

Requirements

Before building the documents, the following packages are required to be installed on your x86 Node of SX-Aurora TSUBASA:

• Sphinx

• Read the Docs Sphinx Theme

• Matplotlib

• NumPy

Building

Before building the documents, please download the package from GitHub:

$ git clone https://github.com/SX-Aurora/nlcpy.git

And, entering the following commands:

$ cd nlcpy
$ sh build_inplace.sh
$ cd doc
$ make html

The documentation is created in the following directory:

$ ls build/html/{en, ja}