Skip to content

Files

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

The latest version of the documentation is available on readthedocs

To generate the documentation locally, do the following:

  • Make sur you installed the requirement at the root of this repo

    pip install -r ../requirements.txt
    
  • Install sphinx with pip and dependencies

    pip install sphinx
    pip install sphinx_rtd_theme
    pip install sphinxcontrib.bibtex
    
  • Then build the documentation:

    sphinx-build -b html source build
    

note do not pay attention the logs warnings

Then go to build folder and open the intex.html file (in a browser for example)