The polycube documentation is not designed to be read on github, so please see our website: TODO: put link here
Our documentation uses sphinx.
In order to install the dependencies do
cd Documentation
pip install -r Documentation/requirements.txt
cd Documentation
make html
cd Documentation
make spelling
The html documentation files will be in the Documentation/_build folder.