Skip to content

Commit 7200a92

Browse files
kevinjqliuFokko
andauthored
[docs] add docs about nightly build (#1670)
Nightly testpypi build was added in #1601 This PR adds a subpage under "Releases" about the nightly build. Running `make docs-serve` locally, ![Screenshot 2025-02-17 at 9 24 59 AM](https://github.com/user-attachments/assets/c3bfacf1-ad4b-4635-b5d7-df3ae41a153d) --------- Co-authored-by: Fokko Driesprong <[email protected]>
1 parent 300b840 commit 7200a92

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

mkdocs/docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
- [Verify a release](verify-release.md)
3131
- [How to release](how-to-release.md)
3232
- [Release Notes](https://github.com/apache/iceberg-python/releases)
33+
- [Nightly Build](nightly-build.md)
3334
- [Code Reference](reference/)
3435

3536
<!-- markdown-link-check-enable-->

mkdocs/docs/nightly-build.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
- Licensed to the Apache Software Foundation (ASF) under one
3+
- or more contributor license agreements. See the NOTICE file
4+
- distributed with this work for additional information
5+
- regarding copyright ownership. The ASF licenses this file
6+
- to you under the Apache License, Version 2.0 (the
7+
- "License"); you may not use this file except in compliance
8+
- with the License. You may obtain a copy of the License at
9+
-
10+
- http://www.apache.org/licenses/LICENSE-2.0
11+
-
12+
- Unless required by applicable law or agreed to in writing,
13+
- software distributed under the License is distributed on an
14+
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
- KIND, either express or implied. See the License for the
16+
- specific language governing permissions and limitations
17+
- under the License.
18+
-->
19+
20+
# Nightly Build
21+
22+
A nightly build of PyIceberg is available on testpypi, [https://test.pypi.org/project/pyiceberg/](https://test.pypi.org/project/pyiceberg/).
23+
24+
To install the nightly build,
25+
26+
```shell
27+
pip install -i https://test.pypi.org/simple/ --pre pyiceberg
28+
```
29+
30+
<!-- prettier-ignore-start -->
31+
32+
!!! warning "For Testing Purposes Only"
33+
Nightly builds are for testing purposes only and have not been validated. Please use at your own risk, as they may contain untested changes, potential bugs, or incomplete features. Additionally, ensure compliance with any applicable licenses, as these builds may include changes that have not been reviewed for legal or licensing implications.
34+
35+
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)