2014-12-21 14 views
22

Czy istnieje sposób, w jaki mogę pobrać dokumenty biblioteki API dla Rust lub wygenerować je? Jedynymi dokumentami, które mogę znaleźć w źródle rdzy, są src/docs.Jak mogę pobrać dokumenty Rust API?

Używam nocnej kompilacji, więc jestem pewien, że istnieje sposób generowania wszystkich dokumentów w ten sam sposób, co standard docs przy użyciu rustdoc, po prostu nie mogę tego znaleźć!

Używam Linuksa, z nightly build, używając komendy:

curl -s https://static.rust-lang.org/rustup.sh | sudo sh 

Odpowiedz

29

Rustup

Jeśli używasz rustup The recommended way to install and update Rust, to dokumentacja może być już zainstalowany; domyślne zachowanie instalacji zmieniło się z czasem. Spróbuj uruchomić rustup doc, aby otworzyć je w przeglądarce.

Jeśli nie są jeszcze zainstalowane, możesz pobrać dokumenty, uruchamiając rustup component add rust-docs.

Domyślnie rustup doc otwiera pierwszą stronę dokumentacji, ale można dodać --std skoczyć prosto do standardowych API docs lub --book dla Rust język programowania.

Samodzielny Rust Instalator

Rust instalator instaluje również dokumentację dla języka i dla Cargo. W systemach Linux można go znaleźć pod adresem /usr/local/share/doc/{rust,cargo}.

7

Innym sposobem, aby uzyskać dokumentację Rusta (i kilka innych języków z ramek do narzędzi CLI) do użytku w trybie offline, jest zainstalowanie Zeal dla systemu Linux lub Dash dla systemu OS X i pobranie tam dokumentacji Rust.

3

Polecam dodanie linku do pliku: ///usr/local/share/doc/rust/html/index.html w zakładkach przeglądarki/pulpitu.

1

Jeśli używasz Arch, zainstaluj rust-docs i przejdź do file:///usr/share/doc/rust/html/index.html.