Skip to content

Add a rustdoc commandline parameter to disable generation of source code pages #115060

New issue

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

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

Already on GitHub? # to your account

Closed
sdroege opened this issue Aug 21, 2023 · 1 comment · Fixed by #115135
Closed

Add a rustdoc commandline parameter to disable generation of source code pages #115060

sdroege opened this issue Aug 21, 2023 · 1 comment · Fixed by #115135
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@sdroege
Copy link
Contributor

sdroege commented Aug 21, 2023

Kind of related to #67804 and the html_no_source attribute.

The behaviour would be the same as the latter but wouldn't require any source code changes. My use-case here is to generate docs on the CI and reduce the size (400MB just for docs for each version is a bit much), but if people want to generate docs locally they should still be able to get the source code pages if they want.

@GuillaumeGomez suggested to create an issue for this.

@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Aug 21, 2023
@GuillaumeGomez
Copy link
Member

To reduce the global documentation size, I suggested in #112379 to group items that don't have impls by kinds. Would require an RFC though.

In any case, I think it's a good idea to add an option to have this done in the command line.

@Noratrieb Noratrieb added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-feature-request Category: A feature request, i.e: not implemented / a PR. A-rustdoc-ui Area: Rustdoc UI (generated HTML) and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Aug 22, 2023
@bors bors closed this as completed in 5cbc00f Aug 23, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants