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

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.

主站蜘蛛池模板: 龙山县| 沂源县| 遵义市| 忻城县| 正镶白旗| 密山市| 广丰县| 南昌县| 福清市| 柘荣县| 佳木斯市| 翁牛特旗| 苏尼特左旗| 沂源县| 怀仁县| 依兰县| 南通市| 读书| 同德县| 石阡县| 宜阳县| 临城县| 汶川县| 衢州市| 灵寿县| 沅江市| 西盟| 大新县| 沈阳市| 扎鲁特旗| 井研县| 土默特左旗| 八宿县| 西乌珠穆沁旗| 清徐县| 安仁县| 会理县| 镶黄旗| 青田县| 清新县| 兴仁县|