Skip to content

Commit 6090d38

Browse files
authored
Add Rust in the SDK section (#1471)
New SDK page for the Rust SDK, with a quickstart from `minio/minio-rs/README.md` Going with an external link to a generated reference. Will deal with API.md as we can. ~We may yet get an `API.md`, so this PR is a draft for now.~
1 parent 522ccf4 commit 6090d38

3 files changed

Lines changed: 36 additions & 15 deletions

File tree

source/developers/minio-drivers.rst

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ MinIO publishes the following Software Development Kits (SDK):
1919
- :ref:`JavaScript <javascript-sdk>`
2020
- :ref:`Haskell <haskell-sdk>`
2121
- :ref:`C++ <cpp-sdk>`
22+
- :ref:`Rust <rust-sdk>`
2223

2324
.. _go-sdk:
2425

@@ -217,26 +218,19 @@ Install
217218
cmake --build ./build --config Debug
218219
219220
220-
..
221-
Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree.
222-
223221
.. _rust-sdk:
224222

225-
Rust (``minio-rs``)
226-
-------------------
227-
228-
Latest Version
229-
|rust-sdk-version|
223+
Rust
224+
----
230225

231-
Reference
232-
:doc:`MinIO Rust SDK Reference </developers/rust/minio-rust>`
226+
GitHub: `minio/minio-rs <https://github.com/minio/minio-rs>`__
233227

234-
Install
235-
To Do
228+
Latest Version
229+
|rust-sdk-version|
236230

231+
Reference: `MinIO Rust SDK Reference <https://docs.rs/minio/latest/minio/>`__
237232

238-
..
239-
Will need to add C++ and Rust to the toctree once released.
233+
Quickstart Guide: :doc:`/developers/rust/minio-rust`
240234

241235
.. toctree::
242236
:titlesonly:
@@ -249,3 +243,4 @@ Install
249243
/developers/java/minio-java
250244
/developers/javascript/minio-javascript
251245
/developers/haskell/minio-haskell
246+
/developers/rust/minio-rust
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _minio-rust-quickstart:
2+
3+
=====================
4+
Rust Quickstart Guide
5+
=====================
6+
7+
.. default-domain:: minio
8+
9+
.. contents:: Table of Contents
10+
:local:
11+
:depth: 2
12+
13+
.. include:: /developers/rust/quickstart.md
14+
:parser: myst_parser.sphinx_
15+
16+
.. toctree::
17+
:titlesonly:
18+
:hidden:
19+
20+
.. /developers/go/API.md

sync-docs.sh

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ function replace() {
1616

1717
function main() {
1818
if [ "$#" -eq 0 ]; then
19-
SDKS="dotnet go java js py hs"
19+
SDKS="dotnet go java js py hs rs"
2020
fi
2121

2222
for sdk in ${SDKS}; do
@@ -37,6 +37,9 @@ function main() {
3737
"hs")
3838
source_dir="haskell"
3939
;;
40+
"rs")
41+
source_dir="rust" # no API.md yet
42+
;;
4043
esac
4144
curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md
4245
curl --retry 10 -Ls -o source/developers/${source_dir}/quickstart.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/README.md
@@ -61,6 +64,9 @@ function main() {
6164
"hs")
6265
replace HASKELLVERSION ${sdk_version}
6366
;;
67+
"rs")
68+
replace RUSTVERSION ${sdk_version}
69+
;;
6470
esac
6571
done
6672
}

0 commit comments

Comments
 (0)