Skip to content

Commit a995b84

Browse files
committed
Instruction to install alpha, beta, rc and nightly
See comments in pydata#1871 (comment)
1 parent fd2c4ab commit a995b84

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/community/setup.md

+23
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,29 @@ It uses automation and as few steps as possible to get things done.
55

66
If you are comfortable with and prefer a more manual setup refer to the [](topics/manual-dev.md) section.
77

8+
## Testing pre-release and nightly
9+
10+
If you are uncomfortable with development, you can already test the alpha, beta
11+
and release candidate of pydata sphinx theme on your your projects. Do do so
12+
simply install with pip using the `--pre` flag:
13+
14+
```console
15+
$ pip install --pre pydata-sphinx-theme
16+
```
17+
18+
If an `alpha`, `beta` or `rc` is available, pip will install it.
19+
20+
You can use the `--pre` flag in your projects continuous integration test suite
21+
to catch regressions or bugs before their release.
22+
23+
If you are even more adventurous pydata-sphinx-theme has nightly build, you can try following the
24+
instructions provided [on the scientific-python/upload-nightly-action
25+
Readme](https://github.com/scientific-python/upload-nightly-action?tab=readme-ov-file#using-nightly-builds-in-ci)
26+
on install nightly wheels.
27+
28+
Again installing nightly wheel on CI jobs is recommended if you wish to help catching bugs ahead of
29+
time.
30+
831
## Workflow for contributing changes
932

1033
We follow a [typical GitHub workflow](https://guides.github.com/introduction/flow/)

0 commit comments

Comments
 (0)