8000 Fix layout of Other Parameters in docs by timhoffm · Pull Request #10995 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Fix layout of Other Parameters in docs #10995

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 1 commit into from
Apr 8, 2018

Conversation

timhoffm
Copy link
Member
@timhoffm timhoffm commented Apr 8, 2018

PR Summary

This fixes #6924.

The cause is within docutils, which have a configuration option
html4css1.writer.field-name-limit: 14. Longer field names such as "Other Parameters" are spread over two columns. An example can be seen in the numpydoc example.

The two-column case does not play nicely with matplotlibs CSS.

This PR changes the docutils settings so that the field-name-limit is larger than "Other Parameters". Consequently, they are rendered like everything else.

Now:
grafik

Before:
grafik

@timhoffm timhoffm added this to the v2.2-doc milestone Apr 8, 2018
@jklymak jklymak merged commit 4966c3f into matplotlib:master Apr 8, 2018
@timhoffm timhoffm deleted the docs-layout-other-parameters branch April 8, 2018 19:06
jklymak added a commit that referenced this pull request Apr 8, 2018
@LindyBalboa
Copy link
Contributor

Wow, nice job hunting that down.

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.

Docstring section "Other Parameters" not rendering with rest of table
4 participants
0