Mastering Rust
上QQ阅读APP看书,第一时间看更新

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.