search

apple / HomeKitADK

Apache License 2.0
2.55k stars 232 forks source link

Default install incomplete #55

Open Riigess opened 4 years ago

Riigess commented 4 years ago

During setup on macOS 10.15.4, the default installer lacked setup for sphinx-build. MacOS doesn't have python3 by default, installing python3 via homebrew results in some issue where you basically need to add sphinx-build to the path using the line below;

PATH="$HOME/Library/Python/3.7/bin:$PATH

sphinx-build installs correctly, sphinx installs correctly, ended up installing sphinx-autobuild attempting to resolve the issue by accident -- works fine regardless.

aajain-com commented 4 years ago

@zeuschops are you talking about python3 requirement for generating documentation in https://github.com/apple/HomeKitADK/blob/master/Tools/generate_api_doc.sh?

Riigess commented 4 years ago

I believe so, this line here; https://github.com/apple/HomeKitADK/blob/6d75ba46ee2c285cd42c1387e084bcdbd7509673/Tools/generate_api_doc.sh#L90

sphinx-build can’t be found by default and needs ~/Library/Python/3.X/bin to be added to path after installation through pip

Riigess commented 3 years ago

Pip now informs you when things needed to be added to path, which kind of resolves this issue. Optionally, I could build a script to add that dependency and automatically add it to path, but not sure if it's worth it since you can just copy and paste the directory. See code below replacing {install path} with the path pip kicks back to add to path.

export PATH="{install path}:$PATH