Fix layout of Other Parameters in docs #10995
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phobson
approved these changes
Apr 8, 2018
jklymak
approved these changes
Apr 8, 2018
jklymak
added a commit
that referenced
this pull request
Apr 8, 2018
Backport PR #10995 on branch v2.2.2-doc
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
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Before:
