Skip to content

Indent our admonitions a bit more #201

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.

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

Closed
choldgraf opened this issue Jun 12, 2020 · 4 comments · Fixed by #207
Closed

Indent our admonitions a bit more #201

choldgraf opened this issue Jun 12, 2020 · 4 comments · Fixed by #207

Comments

@choldgraf
Copy link
Collaborator

I noticed that many other nice-looking documentation sites have an obvious indentation level between their admonition text and the text in the rest of the document.

e.g.:

netlify:

image

metaflow:

image

And a comparison from the sphinx-book-theme for example:

image

This makes me think two things:

  1. We don't have as much whitespace in general in our admonitions
  2. The admonition text feels like it "flows" with the main text in our case because of the lack of indentation

Do others think it would be useful to try adding a bit more whitespace to admonition blocks, and in particular on the left margin?

@jorisvandenbossche
Copy link
Member

Yes, I had the same "first impression" when seeing the admonitioins in the actual pandas docs. We should probably add a bit more margin around the text in the admonitions. Fully agreed!

I think there can be more whitespace in all margins, not only the left

@choldgraf
Copy link
Collaborator Author

choldgraf commented Jun 20, 2020

What about something like:

image

@jorisvandenbossche
Copy link
Member

Looks much better I think!

I would personally still do a little bit more vertical space at the bottom as well.

@choldgraf
Copy link
Collaborator Author

see #207

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants