Skip to content

Build docs into a different directory #11860

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

Closed
brson opened this issue Jan 28, 2014 · 6 comments
Closed

Build docs into a different directory #11860

brson opened this issue Jan 28, 2014 · 6 comments

Comments

@brson
Copy link
Contributor

brson commented Jan 28, 2014

Putting our doc artifacts in the same directory as the source causes problems like in #11833, and it makes some problems for make clean when we do an in-tree build (I think we probably don't clean some of the docs because of this). Let's do the build into a different directory, maybe doc-build, or doc/build? Any better ideas?

@alexcrichton
Copy link
Member

We use the CFG_BUILD version of rustdoc to generate docs, so could we build into $(CFG_BUILD)/doc ?

@huonw
Copy link
Member

huonw commented Jan 28, 2014

Could we enforce out-of-tree builds like servo does?

@brson
Copy link
Contributor Author

brson commented Jan 28, 2014

@huonw We could, but servo only does it because the build system is so bad that an in-tree build causes havok. The docs are the only problem I'm aware of with ours.

@lilyball
Copy link
Contributor

@alexcrichton Does the built docs actually depend on the host/target platform? If so, using CFG_BUILD actually makes sense. If not, then I think doc/build is better.

@alexcrichton
Copy link
Member

How about moving the docs to src/docs?

@lilyball
Copy link
Contributor

@alexcrichton I take it you mean put the documentation source in src/docs and leave the documentation output in doc? I like that.

bors added a commit to rust-lang-ci/rust that referenced this issue Dec 1, 2023
…, r=flip1995

Improve error messages format

Following review in rust-lang/rust-clippy#11845, since there is already suggestions, no need to add the second part of the sentence every time.

r? `@flip1995`

changelog: Improve some error messages
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