官术网_书友最值得收藏!

Hosting documentation

After your documentation has been generated, you will need to host it somewhere for the public to view and use. There are three possibilities here:

  • docs.rs: Crates that are hosted on crates.io get their documentation page automatically generated and hosted on https://docs.rs.
  • GitHub pages: You can host your documentation on the gh-pages branch if your crate is on GitHub.
  • External website: You can manage your own web server for hosting documentation. Rust's standard library documentation is a fine example of this: https://doc.rust-lang.org/std/.

As an added note, if your project's documentation spans more than two to three pages and requires a detailed introduction, then there's a better option to generate book-like documentation. This is done by using the mdbook project. For more information on that, check out their GitHub page at https://github.com/rust-lang-nursery/mdBook.

主站蜘蛛池模板: 永胜县| 蓝山县| 青海省| 柯坪县| 高碑店市| 虹口区| 延边| 宁晋县| 镇沅| 临洮县| 蕉岭县| 全南县| 太湖县| 辽源市| 慈溪市| 尼木县| 罗源县| 克拉玛依市| 丹巴县| 谢通门县| 茶陵县| 洛浦县| 通辽市| 措勤县| 凤城市| 遂川县| 常熟市| 分宜县| 禹城市| 金阳县| 西青区| 巴林右旗| 辉南县| 珲春市| 泰来县| 桦川县| 长泰县| 兴山县| 绥宁县| 通山县| 诏安县|