-
Notifications
You must be signed in to change notification settings - Fork 85
Separate documentation into "Install" and "Build from Source" #1138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
e4cee62 to
590555b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
found some small edits to make. The RST documentation didn't build without warnings. I marked what needs to be fixed. The pipInstall.rst page can use more updating as it talks about -e not being supported, etc.
0ef2355 to
54b6705
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Howdy Reece, nice work. The only thing I see missing is adding a line in the BSK Release Notes that the install instructions have been updated to separate installing via pip and installing from source. Otherwise good to go. Thanks for adding these release notes.
54b6705 to
14c7a7b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice branch. Thanks for updating all the install and build instructions, including the often forgotten README.md file
Description
Now that
bskis available as a wheel on PyPI, the documentation needs to reflect when users should install from PyPI and when they should build from source.This PR introduces a new “Install” section that explains how to install the wheel from PyPI and outlines when building from source is required.
The existing “Build” section has been moved under a new “Build from Source” category to better separate installation methods and developer workflows.from source.
Verification
N/A
Documentation
Removed old docs about building wheels locally
Future work
N/A