#19317: Make warning blocks distinguishable
-------------------------------+--------------------
Reporter: tome | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
This is suggestion to make the warning block in the docs distinguishable
from the note blocks, as they contain a different type of information.
Most (but not all) instances of the warning block are written like this:
{{{
.. warning::
}}}
This way the blocks get the class "warning", which might not be a specific
enough target for css styling. The "philosophy" and "behind the scenes"
blocks on the other hand use the following syntax:
{{{
.. admonition:: Philosophy
}}}
In the example, the div gets a class of "admonition-philosophy". This is
then referred to in the spinx theme css and gives the block a philosophy
icon.
The suggestion is to use the same notation for warning boxes:
{{{
.. admonition:: Warning
}}}
This is already used in a few places in the docs. With this, the divs get
the "admonition-warning" class, to which we can safely apply a different
styling - my suggestion is an orange border and an orange icon.
A suggested icon and a patch for the sphinx theme css are attached, as
well as a screenshot of the result.
--
Ticket URL: <https://code.djangoproject.com/ticket/19317>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
