Skip to content

Latest commit

 

History

History
 
 

docs

Welcome to Helium's documentation

The documentation is built using sphinx and the theme used is sphinx-rtd-theme.

Setting up documentation locally

Ensure you have python and pip installed on your system and then run this command in the project root:

pip install -Ur requirements/docs.txt
make -C docs/ html

This will install all development dependencies for the project and then build the documentation in HTML format in docs/_build/ directory. Open docs/_build/index.html in your browser to see the documentation.