Skip to content

docs: document print.html and reserved print.md#3107

Open
leno23 wants to merge 1 commit into
rust-lang:masterfrom
leno23:docs/print-md-html-3088
Open

docs: document print.html and reserved print.md#3107
leno23 wants to merge 1 commit into
rust-lang:masterfrom
leno23:docs/print-md-html-3088

Conversation

@leno23
Copy link
Copy Markdown

@leno23 leno23 commented May 17, 2026

Summary

Fixes #3088.

Documents how printable output works:

  • print.html — auto-generated when [output.html.print] is enabled; opened by the print menu icon
  • print.md — reserved; must not appear in src/ or SUMMARY.md

Changes

  • guide/src/format/configuration/renderers.md — new subsection under [output.html.print]
  • guide/src/guide/reading.md — clarify print icon behavior

Test plan

  • Documentation only (no code changes)

Made with Cursor

Clarifies that the print button opens auto-generated print.html and
that src/print.md must not be used as a chapter. Fixes rust-lang#3088.

Co-authored-by: Cursor <cursoragent@cursor.com>
@rustbot rustbot added the S-waiting-on-review Status: waiting on a review label May 17, 2026
@leno23
Copy link
Copy Markdown
Author

leno23 commented May 17, 2026

CI is green (15/15). This is docs-only for #3088 — happy to adjust wording if needed. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: waiting on a review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation to include print.md and print.html

2 participants