当前位置:嗨网首页>书籍在线阅读

17-托管文档

  
选择背景色: 黄橙 洋红 淡粉 水蓝 草绿 白色 选择字体: 宋体 黑体 微软雅黑 楷体 选择字体大小: 恢复默认

3.5.3 托管文档

生成文档后,你需要将其托管在某个地方供公众查看和使用。这里存在3种可能性。

  • docs.rs :托管在crates.io上的程序会自动生成说明文档,并托管到docs.rs上。
  • GitHub 页面:如果你的程序是托管在GitHub上的,那么可以将相关的说明文档作为分支托管到GitHub页面上。
  • 外部网站:你可以管理自己的Web服务器用于托管文档。Rust的标准库文档就是一个很好的例子。

此外,如果你的项目文档多于两页,并需要详细介绍,那么生成类似书籍的文档更好。这是通过使用mdbook项目完成的,与之有关的详情,可以访问其主页。