HomeKitADK icon indicating copy to clipboard operation
HomeKitADK copied to clipboard

Default install incomplete

Open Riigess opened this issue 4 years ago • 3 comments

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.

Riigess avatar May 30 '20 21:05 Riigess

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

aajain-com avatar May 31 '20 17:05 aajain-com

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 avatar May 31 '20 19:05 Riigess

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

Riigess avatar Dec 08 '20 18:12 Riigess