Build Documentation

Our documentation is written in restructured text markup and built with Sphinx.

Generate Documentation

To build Intel(R) Extension for Scikit-Learn documentation locally:

1. Clone the repository:

    git clone https://github.com/uxlfoundation/scikit-learn-intelex.git
   

2. Install the scikit-learn-intelex package.

3. Install required documentation builder dependencies using pip:

    pip install -r requirements-doc.txt
   

4. Go to the doc folder:

    cd scikit-learn-intelex/doc
   

5. Run the build-doc.sh script.

You will then find documentation under the _build/html folder.

Additional documentation for the daal4py module can be built with the following steps (after having installed the scikit-learn-intelex packages and doc dependencies):

1. Go to the doc/daal4py folder:

    cd scikit-learn-intelex/doc/daal4py
   

2. Run the makefile (assuming linux):

    make html
   

Documentation will similarly be built under _build/html.