Separate documentation into "Install" and "Build from Source" #1138
Conversation
ReeceHumphreys
force-pushed
the
feature/updated-docs
branch
from
e4cee62 to
590555b
Compare
docs/source/Build.rst
Outdated
| Build/buildExtModules | ||
| Build/customPython | ||
| Build/installBuildConan | ||
| Build/pipInstall |
There was a problem hiding this comment.
We need to keep this link to pipInstall.rst
| :caption: Contents: | ||
| Basilisk can be installed either from `PyPI <https://pypi.org/project/bsk/>`_ as | ||
| a prebuilt wheel or built locally from source. | ||
| The prebuilt wheels include all standard features, such as optical navigation |
There was a problem hiding this comment.
change "all standard features,..." to "all build options,..."
|
|
||
| Building and Installing with ``pip`` | ||
| Building Wheels and Installing with ``pip`` | ||
| ------------------------------------ |
There was a problem hiding this comment.
you need more dashes. They have to match the length of the prior line or you get a sphinx warning.
| Building Basilisk ``wheel`` File | ||
| -------------------------------- | ||
|
|
||
| On its own, there is no significant benefit to installing Basilisk in this way. However, supporting standard Python |
There was a problem hiding this comment.
Line 43 has errand "After installing" statement. Should be deleted.
Do we still need the "Wheel Compatibility" Section?
Section "For Maintainers: Overview of Implementation" needs to be updated. Still talks about not using -e option, for example. Some of this text can be deleted.
| - **macOS:** macOS 11+ (x86_64 and Apple Silicon arm64) | ||
| - **Linux:** Manylinux 2.24+ (x86_64, aarch64) | ||
|
|
||
| All wheels are built as **ABI3** packages for Python **3.8 and newer**. |
There was a problem hiding this comment.
Can we just say "for Basilisk supported Python version"?
This way, when we remove 3.8 support, nothing has to be changed here?
2 participants
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