Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved admonition differentiation #28

Open
bitprophet opened this issue Jan 26, 2015 · 1 comment
Open

Improved admonition differentiation #28

bitprophet opened this issue Jan 26, 2015 · 1 comment

Comments

@bitprophet
Copy link
Collaborator

After #21 I find myself wondering if seealso blocks shouldn't still have some other color to differentiate themselves from note blocks.

Quick check of other themes re: seealso vs note:

  • snide/sphinx_rtd_theme does not differentiate between note / seealso at all.
  • Sphinx default and traditional themes set note to gray and seealso to the same yellows our source theme(s) do (unsurprising since presumably Armin worked off of the default originally).
  • The 'bootstrap' theme doesn't appear to style seealso at all, though it sets note, warn and danger to distinct colors aligning with (surprise) Bootstrap: http://ryan-roemer.github.io/sphinx-bootstrap-theme/examples.html#admonitions
@bitprophet bitprophet mentioned this issue Jan 26, 2015
Closed
@bitprophet bitprophet mentioned this issue Nov 19, 2015
Open
@bitprophet bitprophet changed the title More color, or at least improved admonition differentiation Improved admonition differentiation Nov 19, 2015
@bitprophet
Copy link
Collaborator Author

Moved "more color" note to #60, having multi-issue issues is dumb.

ShadowKyogre added a commit to ShadowKyogre/alabaster that referenced this issue Jul 13, 2016
@ShadowKyogre
Improved admonition differentiation
dd8fdae 
Addresses sphinx-doc#28 and sphinx-doc#6.

To do this, explicit styling.

The Sphinx RTD theme uses the same styling for the following groups:
- blue: note, custom admonitions, seealso
- red: danger, error
- yellow: attention, caution, danger
- green: tip, hint, important

Because Alabaster's default aesthetics are not as shiny, we use the
following instead:
- gray: note, custom admonitions, seealso
- pink with darker pink shadow: danger, error
- pink: attention, caution, danger
- gray: tip, hint, important

In addition, the different admonition styles are separated into a better
set of comments for their readability.
ShadowKyogre added a commit to ShadowKyogre/alabaster that referenced this issue Jul 13, 2016
@ShadowKyogre
Improved admonition differentiation
a6229eb 
Addresses sphinx-doc#28 and sphinx-doc#6.

To do this, explicit styling was applied for the different admonition
types.

The Sphinx RTD theme uses the same styling for the following groups:
- blue: note, custom admonitions, seealso
- red: danger, error
- yellow: attention, caution, danger
- green: tip, hint, important

Because Alabaster's default aesthetics are not as shiny, we use the
following instead:
- gray: note, custom admonitions, seealso
- pink with darker pink shadow: danger, error
- pink: attention, caution, danger
- gray: tip, hint, important

In addition, the different admonition styles are separated into a better
set of comments for their readability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bitprophet