[Django] #37138: Outdated docs CSS in local and preview builds

0 views
Skip to first unread message

Django

unread,
5:45 PM (5 hours ago) 5:45 PM
to django-...@googlegroups.com
#37138: Outdated docs CSS in local and preview builds
-------------------------------------+-------------------------------------
Reporter: Mike | Owner: Mike Edmunds
Edmunds |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 6.0
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
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 ([https://forum.djangoproject.com/t/increasing-
size-of-html-text-in-django-docs-default-theme/45210 forum discussion])
* are missing semantically-important styles
([https://forum.djangoproject.com/t/why-does-local-django-docs-have-a
-different-styling-theme-than-the-official-one/32761/3 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.)
--
Ticket URL: <https://code.djangoproject.com/ticket/37138>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Reply all
Reply to author
Forward
0 new messages