Skip to content

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

embARC MLI Documentation

The embARC MLI documentation can be built using Sphynx together with the theme provided by Read the Docs

To build the documentation you first need to install Python. See these instructions as one of the ways to do so.

Requirements for building the embARC documentation are listed in the requirements.txt. Install it in the following way:

pip install -r doc/requirements.txt

To build documentation open command line in the repo root, change working directory to doc folder and use make using html target

cd doc
gmake html

To open the documentation, open doc/build/html/index.html in a browser.