Opened 2 months ago

Closed 2 weeks ago

#37134 closed Cleanup/optimization (wontfix)

Fontawesome console tab icons not appearing in locally generated html docs

Reported by: James Beard Owned by: James Beard
Component: Documentation Version: 6.0
Severity: Normal Keywords: icon, fontawesome, sphinx-theme
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

When generating HTML django docs locally the console tab icons (Windows, Linux, Mac) are broken and appear as missing unicode squares.

To reproduce, check out the django source, install docs dependencies, and run make html in docs/. On relevant pages e.g. ​http://localhost:3000/topics/install the icons in the tabs above the console blocks look like this: □/□ □

The cause is in the default djangodocs theme and is twofold:

  1. the static file console-tabs.css contains a dynamic path meant to be interpreted, however that file is just copied verbatim by sphinx
  2. the @font-face name defined in fa-brands.min.css doesn't match what's used elsewhere in the theme CSS

Have a fix already so happy to take ownership if accepted.

Change History (5)

comment:1 by Tim Graham, 2 months ago

Triage Stage: Unreviewed → Accepted

comment:2 by James Beard, 2 months ago

Has patch: set

​PR

comment:3 by Mike Edmunds, 2 months ago

Keywords: sphinx-theme added

comment:4 by blighj, 3 weeks ago

Patch needs improvement: set

comment:5 by James Beard, 2 weeks ago

Resolution: → wontfix
Status: assigned → closed

With the intended approach for accessible tabs being text based (no icons) fixing this won't be necessary. Ticket #35874 has more background on the path forward from here.

Note: See TracTickets for help on using tickets.
Back to Top