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

Consider installing HTML documentation #14916

Closed
SiegeLord opened this issue Jun 15, 2014 · 9 comments
Closed

Consider installing HTML documentation #14916

SiegeLord opened this issue Jun 15, 2014 · 9 comments

Comments

@SiegeLord
Copy link
Contributor

The best documentation to use while programming in Rust is the one that matches the nightly/master that is installed. To that end, it'd be convenient if install.sh installed the HTML documentation somewhere (e.g. ${PREFIX}/share/doc/rust for Linux). Something similar should be done for Windows.

@brson
Copy link
Contributor

brson commented Jun 16, 2014

Agreed.

@brson
Copy link
Contributor

brson commented Oct 1, 2014

An ugly problem here is going to be just generating the documentation on every platform because we use pandoc and tex to generate the PDF's. We might consider explicitly excluding the PDF's from the binary distribution.

@brson
Copy link
Contributor

brson commented Oct 1, 2014

(I know the title says 'HTML' but I consider it all just 'docs', and it will take special effort to not include the PDF's).

@brson brson mentioned this issue Oct 1, 2014
65 tasks
@michaelsproul
Copy link
Contributor

The nightly binary archives already include HTML-only documentation. Would a PR modifying install.sh with an option to install these docs be beneficial?

It doesn't help Windows or building from source, but it's a start?

@brson
Copy link
Contributor

brson commented Nov 21, 2014

@michaelsproul Sorry for not getting back to you. I'm about to do a major refactoring of the installer, so I'll try to make this happen there.

@michaelsproul
Copy link
Contributor

@brson No worries!

@brson
Copy link
Contributor

brson commented Jan 5, 2015

We're installing the documentation now. I have a todo to make the tarball installers allow selection of individual components to not install docs, but considering this done.

@brson brson closed this as completed Jan 5, 2015
@michaelsproul
Copy link
Contributor

Thanks! 😄

@vks
Copy link
Contributor

vks commented Aug 12, 2016

Is there an option for not installing the docs? For me it takes by far the longest when updating.

bors added a commit to rust-lang-ci/rust that referenced this issue Jun 5, 2023
feat: Add diagnostic for `_` expressions (typed holes)
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

No branches or pull requests

4 participants