Skip to content

Commit 590555b

Browse files
Minor tweaks to wheel instructions
1 parent 9ce4a9e commit 590555b

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

docs/source/Build/pipInstall.rst

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,17 @@
33

44
.. _pipInstall:
55

6-
Advanced: Building and Installing Pre-Compiled Basilisk Wheels
7-
==============================================================
6+
Advanced: Building Pre-Compiled Basilisk Wheels
7+
===============================================
88

9-
.. warning::
10-
11-
:beta:`Pip Wheel Support` This method of building Basilisk is currently a beta feature, and should only be attempted by advanced users
12-
familiar with `Python packaging and distribution
13-
<https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/>`_.
14-
This method is not yet guaranteed to work on every platform, and there are still some annoyances
15-
to iron out, but we appreciate any feedback you may have.
9+
The following instructions explain how to build wheels with Basilisk.
10+
While we distribute pre-compiled wheels already in :ref:`bskInstall`,
11+
you can also build them manually using the steps below. This is desirable if
12+
you want to use Python wheels but still need to enable custom build options
13+
or link against a custom external module location.
1614

17-
Most users should see :ref:`configureBuild` for documentation on the regular build process.
1815

19-
20-
Building and Installing with ``pip``
16+
Building Wheels and Installing with ``pip``
2117
------------------------------------
2218

2319
.. note::
@@ -49,11 +45,6 @@ After installing
4945
Building Basilisk ``wheel`` File
5046
--------------------------------
5147

52-
On its own, there is no significant benefit to installing Basilisk in this way. However, supporting standard Python
53-
packaging tools means that Basilisk can now be built into a pre-compiled `"wheel" (.whl) file
54-
<https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#wheels>`_ that can be shared
55-
and installed on other compatible machines.
56-
5748
Using ``pip``, the command below will generate a ``Basilisk-*.whl`` file in the current directory::
5849

5950
pip wheel --no-deps -v .

0 commit comments

Comments
 (0)