Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update documentation CSS #11411

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

Merged
merged 5 commits into from
Jun 12, 2018
Merged

Update documentation CSS #11411

merged 5 commits into from
Jun 12, 2018

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Jun 10, 2018

PR Summary

This updates the CSS of the documentation. In particular this

  • Slightly increases the font size of signatures so that the stand out a bit from the following text.
  • Changes style and color of admonitions and deprecated info. Text-related have now non-rounded edges and a bar on the left. The old style of boxes with rounded edges is now reserved to code and call signatures. This should make it easier to distinguish the two categories. See e.g. the hint example below.
  • Changed the "See Also" color from yellow to blue. The original yellow color was hard to read and reminded more of a warning.
  • Restyled the table of contents (optionally use multiple columns)
  • Some fixes of CSS inconsistencies and duplicate definitions.

Following are some examples:

Signature font size

before:

grafik

after:

grafik

Deprecation

before:

grafik

after:

grafik

See Also

before:

grafik

after:

grafik

Warning

before:

grafik

after:

grafik

Note

before:

grafik

after:

grafik

Hint

before

grafik

after:

grafik

Table of contents

before:

grafik

after:

grafik

}

/* function and class description */
dl.function, dl.method, dl.attribute {
dl.method, dl.classmethod, dl.staticmethod dl.attribute {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comma missing, dl.staticmethod, dl.attribute

@jklymak
Copy link
Member

jklymak commented Jun 10, 2018

This looks great in general!

However, Not a huge fan of the signature font size change. It’s already highlighted, italics and a different indent. Making larger makes it wrap more for the longer signatures.

@ImportanceOfBeingErnest
Copy link
Member

Currently the font-size of the signatures is 13.3px. Would changing it to 14px instead of 15 px not suffice?

@timhoffm
Copy link
Member Author

timhoffm commented Jun 11, 2018

Ok, changed font-size to 14px.

Side remark: I'm not quite sure all the font-size settings in the CSS are consistent/intentional. But that's something to look at at another time.

@tacaswell tacaswell added this to the v2.2-doc milestone Jun 11, 2018
@timhoffm
Copy link
Member Author

Update: Table styles (see above).

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this is a nice improvement. Will wait for another approval since its kind of a big change...

@tacaswell tacaswell merged commit ed0a579 into matplotlib:master Jun 12, 2018
@lumberbot-app
Copy link

lumberbot-app bot commented Jun 12, 2018

There seem to be a conflict, please backport manually

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

Successfully merging this pull request may close these issues.

5 participants