Skip to content

Commit 9ec11a3

Browse files
committed
Add Rust API docs to the website
Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
1 parent 260062c commit 9ec11a3

2 files changed

Lines changed: 62 additions & 2 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,33 @@ jobs:
193193
name: api-python
194194
path: lang/py/docs/build/
195195

196+
build-api-rust:
197+
name: Build Rust API docs
198+
runs-on: ubuntu-latest
199+
steps:
200+
- name: Checkout
201+
uses: actions/checkout@v4
202+
with:
203+
repository: 'apache/avro-rs'
204+
205+
- name: Rust Toolchain
206+
uses: dtolnay/rust-toolchain@stable
207+
with:
208+
toolchain: stable
209+
210+
- name: Build Rustdocs
211+
run: |
212+
set -x
213+
cargo doc --all-features
214+
- uses: actions/upload-artifact@v4
215+
with:
216+
name: api-rust
217+
path: target/doc
218+
219+
196220
push-website:
197221
name: Push website
198-
needs: [build-website, build-api-c, build-api-cpp, build-api-csharp, build-api-java, build-api-python]
222+
needs: [build-website, build-api-c, build-api-cpp, build-api-csharp, build-api-rust, build-api-python]
199223
runs-on: ubuntu-latest
200224
steps:
201225
- name: Checkout
@@ -245,6 +269,12 @@ jobs:
245269
name: api-python
246270
path: api-python
247271

272+
- name: Download api-rust
273+
uses: actions/download-artifact@v4
274+
with:
275+
name: api-rust
276+
path: api-rust
277+
248278
- name: Copy the generated HTML
249279
run: |
250280
set -x
@@ -257,7 +287,8 @@ jobs:
257287
mv api-csharp/* $WEBSITE_API/csharp/html/
258288
mv api-java/* $WEBSITE_API/java/
259289
mv api-python/* $WEBSITE_API/py/
260-
rmdir api-c api-c++ api-csharp api-java api-python
290+
mv api-python/* $WEBSITE_API/rust/
291+
rmdir api-c api-c++ api-csharp api-java api-python api-rust
261292
262293
- name: Checkout old docs versions from Subversion
263294
run: |
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Rust API"
3+
linkTitle: "Rust API"
4+
weight: 105
5+
manualLink: /docs/++version++/api/rust/
6+
---
7+
8+
<!--
9+
10+
Licensed to the Apache Software Foundation (ASF) under one
11+
or more contributor license agreements. See the NOTICE file
12+
distributed with this work for additional information
13+
regarding copyright ownership. The ASF licenses this file
14+
to you under the Apache License, Version 2.0 (the
15+
"License"); you may not use this file except in compliance
16+
with the License. You may obtain a copy of the License at
17+
18+
https://www.apache.org/licenses/LICENSE-2.0
19+
20+
Unless required by applicable law or agreed to in writing,
21+
software distributed under the License is distributed on an
22+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23+
KIND, either express or implied. See the License for the
24+
specific language governing permissions and limitations
25+
under the License.
26+
27+
-->
28+
29+
The Rust API documentation can be found <a href="/docs/++version++/api/rust/">here</a>.

0 commit comments

Comments
 (0)