Improve API doc empty-space formatting #14
Merged
Conversation
This file contains 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
akaszynski
approved these changes
Dec 11, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds some custom styling to improve the grouping and readability of generated API docs. Side by side comparison (current on left, proposed on right):
There's less space between 'Parameters' and 'Examples', and more space between 'Examples' and the methods. This helps the examples feel more like they belong to the class itself, as opposed to the method below.
I'm not a CSS expert, but I think the selectors are appropriate and seem to align with how the styling is written in the base sphinx package. These changes have been tested on the example API Documentation in this package, and on the as-yet-unreleased grantami-bomanalytics package.