From 6090d389da39c2865d4e886334eb727f20e8508e Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 4 Jun 2025 08:53:20 -0600 Subject: [PATCH] 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.~ --- source/developers/minio-drivers.rst | 23 +++++++++-------------- source/developers/rust/minio-rust.rst | 20 ++++++++++++++++++++ sync-docs.sh | 8 +++++++- 3 files changed, 36 insertions(+), 15 deletions(-) create mode 100644 source/developers/rust/minio-rust.rst diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index 444cf562..e4b033c0 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -19,6 +19,7 @@ MinIO publishes the following Software Development Kits (SDK): - :ref:`JavaScript ` - :ref:`Haskell ` - :ref:`C++ ` +- :ref:`Rust ` .. _go-sdk: @@ -217,26 +218,19 @@ Install cmake --build ./build --config Debug -.. - Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree. - .. _rust-sdk: - Rust (``minio-rs``) - ------------------- +Rust +---- - Latest Version - |rust-sdk-version| +GitHub: `minio/minio-rs `__ - Reference - :doc:`MinIO Rust SDK Reference ` +Latest Version + |rust-sdk-version| - Install - To Do +Reference: `MinIO Rust SDK Reference `__ - -.. - Will need to add C++ and Rust to the toctree once released. +Quickstart Guide: :doc:`/developers/rust/minio-rust` .. toctree:: :titlesonly: @@ -249,3 +243,4 @@ Install /developers/java/minio-java /developers/javascript/minio-javascript /developers/haskell/minio-haskell + /developers/rust/minio-rust diff --git a/source/developers/rust/minio-rust.rst b/source/developers/rust/minio-rust.rst new file mode 100644 index 00000000..16c51023 --- /dev/null +++ b/source/developers/rust/minio-rust.rst @@ -0,0 +1,20 @@ +.. _minio-rust-quickstart: + +===================== +Rust Quickstart Guide +===================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. include:: /developers/rust/quickstart.md + :parser: myst_parser.sphinx_ + +.. toctree:: + :titlesonly: + :hidden: + + .. /developers/go/API.md diff --git a/sync-docs.sh b/sync-docs.sh index 45824b65..3cea12bb 100755 --- a/sync-docs.sh +++ b/sync-docs.sh @@ -16,7 +16,7 @@ function replace() { function main() { if [ "$#" -eq 0 ]; then - SDKS="dotnet go java js py hs" + SDKS="dotnet go java js py hs rs" fi for sdk in ${SDKS}; do @@ -37,6 +37,9 @@ function main() { "hs") source_dir="haskell" ;; + "rs") + source_dir="rust" # no API.md yet + ;; esac curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md 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() { "hs") replace HASKELLVERSION ${sdk_version} ;; + "rs") + replace RUSTVERSION ${sdk_version} + ;; esac done }