Skip to content

Commit

Permalink
Added instructions for usage
Browse files Browse the repository at this point in the history
  • Loading branch information
mostaphaRoudsari authored Mar 15, 2019
1 parent 32b8c8b commit c9bd72c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

## Usage
For generating the documents localy use commands below from the root folder.

```shell
# 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
```

0 comments on commit c9bd72c

Please sign in to comment.