Opened 42 minutes ago
#37138 assigned Cleanup/optimization
Outdated docs CSS in local and preview builds
| Reported by: | Mike Edmunds | Owned by: | Mike Edmunds |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The CSS used for documentation in local and ReadTheDocs PR preview builds is significantly different from the CSS used on docs.djangoproject.com.
The styles in docs/_theme/djangodocs/static/djangodocs.css:
- have usability problems (forum discussion)
- are missing semantically-important styles (forum discussion)
- don't support dark mode
These and other differences complicate contributing to the documentation, as you can't really be sure how it's going to look until the PR is merged and published.
We should find a way to replace docs/_theme/djangodocs/static/*.css with the styles from djangoproject.com. (E.g., the result of make compile-scss-debug in that project.)