Make warning blocks distinguishable
|Reported by:||tome||Owned by:||nobody|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||yes|
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:
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.
Change History (10)
comment:1 Changed 3 years ago by tome
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Type changed from Uncategorized to Cleanup/optimization
comment:3 Changed 3 years ago by jezdez
- Patch needs improvement set
- Triage Stage changed from Unreviewed to Accepted
comment:4 Changed 3 years ago by Tim Graham <timograham@…>
- Resolution set to fixed
- Status changed from new to closed