Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention in the book that offline docs are installed #23244

Closed
mdinger opened this issue Mar 10, 2015 · 3 comments · Fixed by #23279
Closed

Mention in the book that offline docs are installed #23244

mdinger opened this issue Mar 10, 2015 · 3 comments · Fixed by #23279

Comments

@mdinger
Copy link
Contributor

mdinger commented Mar 10, 2015

State in installation that offline local docs are installed with Rust and note the location of them. This question comes up often.

@mdinger mdinger changed the title Mention in the book that where offline docs are installed Mention in the book that offline docs are installed Mar 10, 2015
@mdinger
Copy link
Contributor Author

mdinger commented Mar 10, 2015

State how to generate a PDF it it's possible unless you want to start bundling a PDF with the installation (which isn't that bad an idea). This is a secondary goal though.

@carols10cents
Copy link
Member

It'd also be cool if the end of installation pointed this out as well, something like:

$ sudo ./install.sh 
install: creating uninstall script at /usr/local/lib/rustlib/uninstall.sh
install: installing component 'rustc'
install: installing component 'cargo'
install: installing component 'rust-docs'

    Rust is ready to roll.
    Offline API docs: `open /usr/local/share/doc/rust/html/std/index.html`
    Offline book: `open /usr/local/share/doc/rust/html/book/index.html`

@mdinger
Copy link
Contributor Author

mdinger commented Mar 10, 2015

cc @brson

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants