Separate documentation into "Install" and "Build from Source" #1138
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ReeceHumphreys
force-pushed
the
feature/updated-docs
branch
from
e4cee62 to
590555b
Compare
schaubh
requested changes
Oct 13, 2025
Contributor
schaubh
left a comment
schaubh
left a comment
There was a problem hiding this comment.
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.
ReeceHumphreys
force-pushed
the
feature/updated-docs
branch
4 times, most recently
from
0ef2355 to
54b6705
Compare
schaubh
approved these changes
Oct 24, 2025
Contributor
schaubh
left a comment
schaubh
left a comment
There was a problem hiding this comment.
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.
ReeceHumphreys
force-pushed
the
feature/updated-docs
branch
from
54b6705 to
14c7a7b
Compare
schaubh
approved these changes
Oct 27, 2025
Contributor
schaubh
left a comment
schaubh
left a comment
There was a problem hiding this comment.
Nice branch. Thanks for updating all the install and build instructions, including the often forgotten README.md file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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