Skip to content

Separate templates from rustdoc source #29323

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
steveklabnik opened this issue Oct 26, 2015 · 5 comments
Closed

Separate templates from rustdoc source #29323

steveklabnik opened this issue Oct 26, 2015 · 5 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@steveklabnik
Copy link
Member

If you want to modify anything about the way that rustdoc outputs HTML, you end up having to edit rustdoc's source. This causes a really long cycle time, as you have to re-compile rustdoc on each change.

Many people I've talked to about editing rustdoc's output have said "well, just show me where the template is, and I'll change it", and the answer is 😭

The only real issue with this is that to do it right, we'd end up having a dependency on a template system, because re-implementing one doesn't seem like the right idea as well. I'm not sure if that's an acceptable tradeoff or not.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 26, 2015
@steveklabnik
Copy link
Member Author

@alexcrichton points out to me that an issue with this is we'd still want to distribute said templates inside of rustdoc itself, which means ultimately, still re-building rustdoc. Not sure if there could be some sort of "load template from here" switch or something, which would help iteration time during development.

@nagisa
Copy link
Member

nagisa commented Oct 26, 2015

We already have attributes for logo and whatnot. I don’t see why we couldn’t have one for a directory to some sort of well specified templates.

@steveklabnik
Copy link
Member Author

Triage: no change.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Jul 24, 2017
@steveklabnik
Copy link
Member Author

Triage: no real movement on this

@Mark-Simulacrum
Copy link
Member

I'm going to go ahead and close this as this ultimately is a "rustdoc is slow to build for the first time" issue and this isn't really the right issue to track that. FWIW, I do think that we can make significant progress on that issue and maybe even solve it outright, but it'll take some legwork in bootstrap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants