Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Usage

For generating the documents locally, use commands below from the root folder.

# install dependencies
pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme

# generate rst files for ladybug modules except for euclid
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py

# build the documentation under _build/docs folder
sphinx-build -b html ./docs ./docs/_build/docs