Opened 13 years ago
Closed 13 years ago
#8320 closed defect (fixed)
Make HTML doc headers and footers more compact
| Reported by: | Mitesh Patel | Owned by: | Minh Van Nguyen |
|---|---|---|---|
| Priority: | trivial | Milestone: | sage-4.3.4 |
| Component: | documentation | Keywords: | |
| Cc: | Merged in: | sage-4.3.4.alpha0 | |
| Authors: | Mitesh Patel | Reviewers: | Minh Van Nguyen |
| Report Upstream: | N/A | Work issues: | |
| Branch: | Commit: | ||
| Dependencies: | Stopgaps: |
Status badges
Description (last modified by )
We can use Sphinx's html_short_title setting to [try to] keep links from overflowing the header and footer.
This could be useful for devices with small-screen or large fonts (e.g., for accessibility).
For example, instead of "Sage Reference Manual v4.3.3," we can use "Reference v4.3.3," which should help for deeply nested pages.
Attachments (2)
Change History (6)
Changed 13 years ago by
| Attachment: | trac_8320-html_short_title.patch added |
|---|
comment:1 Changed 13 years ago by
| Authors: | → Mitesh Patel |
|---|---|
| Description: | modified (diff) |
| Milestone: | → sage-4.3.3 |
| Priority: | minor → trivial |
| Status: | new → needs_review |
The patch adds shorter HTML titles, which appear in Sphinx headers and footers, for selected docs: the developer's guide, Bordeaux lectures, numerical primer, and reference manual. The others' titles overflow only with very large font sizes. But feel free to make adjustments, e.g., for consistency.
comment:2 Changed 13 years ago by
| Reviewers: | → Minh Van Nguyen |
|---|
The reviewer patch trac_8320-reviewer.patch shortens the HTML title of these documents:
- A Tour of Sage
- Sage Installation Guide
I also changed the short title of the reference manual from "Reference" to "Sage Reference" as an attempt to be consistent with these short titles:
- Sage Tutorial
- Sage Constructions
- Sage Tour
Only my patch needs review by anyone but me.
comment:3 Changed 13 years ago by
| Status: | needs_review → positive_review |
|---|
comment:4 Changed 13 years ago by
| Merged in: | → sage-4.3.4.alpha0 |
|---|---|
| Resolution: | → fixed |
| Status: | positive_review → closed |
Merged in this order:
HTML short titles for selected docs. sage repo.