2015-01-10 11 views
5

Có lệnh nào truy cập tài liệu hướng dẫn rust-lang api từ dòng lệnh linux không?Làm cách nào để truy cập tài liệu API từ dòng lệnh trên Linux?

tôi là sau khi một cái gì đó tương tự như ví dụ này cho các tài liệu golang:

godoc strings Contains

mang đến cho đầu ra:

GÓI TÀI LIỆU

gói chuỗi nhập khẩu "chuỗi"

FUN CTIONS

func Chứa (s, chuỗi chất nền) bool Chứa trả về đúng nếu bề mặt nằm trong s.

Tôi biết có lệnh rustdoc nhưng chỉ tạo tài liệu, nó không hiển thị tài liệu.

+0

Tôi nghĩ bạn sẽ cần thiết lập đầu ra của 'rustdoc' thành một trình phân tích cú pháp HTML, và sau đó grep cho hàm đó. Bạn có thể có thể thiết lập một kịch bản shell đơn giản để làm điều này, hoặc thậm chí là một bí danh vỏ. Hãy xem http://www.w3.org/Tools/HTML-XML-utils/ (nên có sẵn trên hầu hết các Unices), đặc biệt là 'hxextract'. – Intermernet

+0

Tôi không phải là anh chàng sysadmin, có lẽ nếu bạn có thể xây dựng bởi vì khi tôi gõ 'rustdoc vec :: each', tôi gặp lỗi. Đường ống đầu ra của lỗi sẽ không làm tốt lắm. –

+1

Tôi không nghĩ bạn có thể làm điều đó. Xem https://github.com/rust-lang/rust/issues/2207. Nó có lẽ không quá xa mặc dù, họ đang di chuyển rất nhanh chóng vào lúc này! – Intermernet

Trả lời

1

Giải pháp duy nhất cho đến nay sẽ là sử dụng trình duyệt dòng lệnh như lynx và truy cập http://doc.rust-lang.org/std/index.html.

Hoặc như Intermernet đã lưu ý bạn có thể chuyển tài liệu HTML thành hàm grep. Nếu tôi không nhầm, các nightlies nên đi kèm với tài liệu tuân thủ, nếu bạn yêu cầu tài liệu API.

0

Tôi tạo ra một chức năng vỏ nhỏ để tạo và mở các tài liệu trong một dự án tại nhà ga sử dụng pandoclynx:

cli-rustdoc() { 
    cargo doc -p "$1"; pandoc "target/doc/$1/index.html" | lynx -stdin 
} 

dụ Cách sử dụng: $ cli-rustdoc rand

Không hoàn hảo, nhưng nó là thủ thuật cho hầu hết các phần.

Các vấn đề liên quan