Render doc locally


#1

Hi,

I would like to know if there is a way to render the Rust docs locally. For example, if I fork the rust repository and make some changes to the doc. Is there a way to see what those changes might look like before creating a pull-request ?


#2

I think you mean cargo doc.
The docs will be in target/doc.


#3

Hmm that doesn’t seem to work in the rust repository because there is no Cargo.toml. Is there something I am missing here?


#4

Rustdoc?
https://doc.rust-lang.org/book/documentation.html


#5

I think I found out how to do it :slight_smile:

$ ./configure
$ make all

( I tried make before, but I hadn’t run ./configure )

and later when only the doc needs to be build:

$ make doc

It’s building at the moment :blush: