Skip to content

Commit 1bb2218

Browse files
[#1356] Add docs
1 parent ecb3d58 commit 1bb2218

3 files changed

Lines changed: 47 additions & 0 deletions

File tree

docs/source/Install.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,48 @@ versions.
6666
This requires a C++ compiler toolchain and standard build tools
6767
to be installed on your system.
6868

69+
Nightly Builds
70+
--------------
71+
72+
Nightly pre-release wheels are built automatically from the ``develop`` branch and
73+
published to the Basilisk nightly index for all supported platforms. These
74+
builds are replaced each night and reflect the latest state of active development.
75+
They are intended for testing and early access to new features, but may be
76+
unstable and are not recommended for production use.
77+
78+
To install the latest nightly build, use the Basilisk nightly index as the primary
79+
source, allow pip to fall back to PyPI for dependencies, and pass ``--pre`` since
80+
nightly wheels are pre-release versions:
81+
82+
.. code-block:: bash
83+
84+
pip install \
85+
--index-url https://avslab.github.io/basilisk/nightly/ \
86+
--extra-index-url https://pypi.org/simple/ \
87+
--pre \
88+
bsk
89+
90+
Because nightly wheels are built from the ``develop`` branch and carry the same
91+
version string until ``bskVersion.txt`` changes, pip may report
92+
``Requirement already satisfied`` even when a newer build is available. To
93+
force an overwrite of whatever is currently installed, add
94+
``--upgrade --force-reinstall --no-cache-dir``:
95+
96+
.. code-block:: bash
97+
98+
pip install \
99+
--index-url https://avslab.github.io/basilisk/nightly/ \
100+
--extra-index-url https://pypi.org/simple/ \
101+
--pre \
102+
--upgrade --force-reinstall --no-cache-dir \
103+
bsk
104+
105+
.. warning::
106+
107+
Nightly builds are development snapshots and are not suitable for production use.
108+
For stable releases, install from `PyPI <https://pypi.org/project/bsk/>`_ as described above.
109+
110+
69111
Basilisk Support Data
70112
---------------------
71113

docs/source/Support/Developer/releaseGuide.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ To prepare ``develop`` for the next beta cycle:
3030
#. Update ``docs/source/Support/bskReleaseNotes.rst``
3131
and ``docs/source/Support/bskKnownIssues.rst`` files to next beta cycle
3232
#. Make PR and push to ``develop``
33+
#. Manually run the ``Nightly Wheels`` workflow using the ``workflow_dispatch``
34+
trigger after merging the beta branch so the nightly package index is
35+
republished on GitHub Pages.
3336

3437

3538
The following documentation provides detailed instructions for some of these steps.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- Fixed the ``Nightly Wheels`` GitHub Actions workflow so gh-pages history trimming uses a full ``gh-pages`` checkout and no longer fails after sparse ``develop`` checkout.
2+
- Added release-guide instructions to manually run ``Nightly Wheels`` via ``workflow_dispatch`` after pushing the next beta branch to republish the nightly package index.

0 commit comments

Comments
 (0)