如何从Linux上的命令行访问API文档?

时间:2015-01-10 09:24:30

标签: rust

是否有命令从linux命令行访问rust-lang api文档?

我在golang文档中使用类似于此示例的内容之后:

godoc strings Contains

给出输出:

  

包装文件

     

包字符串       import" strings"

     

功能

     

func包含(s,substr string)bool       如果substr在s内,则包含返回true。

我知道有一个rustdoc命令,但它只生成文档,但它没有显示它。

3 个答案:

答案 0 :(得分:8)

我们还没有这样的工具,但想要一个。 https://github.com/rust-lang/rfcs/issues/650正在跟踪此问题。

(以前跟踪为https://github.com/rust-lang/rust/issues/6160

答案 1 :(得分:1)

到目前为止,唯一的解决方案是使用命令行浏览器,如lynx,然后转到http://doc.rust-lang.org/std/index.html

或者正如Intermernet所说,你可以将HTML文档传递给grep函数。如果我没有弄错的话,如果您需要API文档,则应该使用已编译的文档。

答案 2 :(得分:1)

我创建了一个小型shell函数,使用pandoclynx生成并打开终端项目中的文档:

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

用法示例:$ cli-rustdoc rand

不完美,但它在很大程度上起到了作用。