API Reference Fix for Right Margin#1558
Merged
tonybove-apple merged 1 commit intoapple:mainfrom Jul 26, 2022
tonybove-apple:api-ref-fix-right-margin
Merged
API Reference Fix for Right Margin#1558tonybove-apple merged 1 commit intoapple:mainfrom tonybove-apple:api-ref-fix-right-margin
tonybove-apple merged 1 commit intoapple:mainfrom
tonybove-apple:api-ref-fix-right-margin
Conversation
tonybove-apple
added
the
docs
aseemw
approved these changes
Jul 25, 2022
TobyRoseman
approved these changes
Jul 26, 2022
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR changes the API Reference documentation to remove the right margin so that text and examples don't appear to be extending beyond it. See attached figures for examples.
_static/css/norightmargin.css: Overrides the right margin setting to set the maximum width to none. As a result, the right margin changes depending on the side of the window, and text that is supposed to wrap continues to wrap correctly. See attached figures for examples.conf.py: Add thehtml_static_pathandhtml_css_filesoptions. This enables thecss/norightmargin.cssCSS override.Figures:
Current #1: Converters > Unified: Right margin in Parameters section.
Fixed #1: Converters > Unified
Current #2: Models >
compression_utils>palettize_weights: Right margin in Parameters section.Fixed #2: Models >
compression_utils>palettize_weightsCurrent #3: Mil Ops >
tensor_transformation: Right margin for some class headers.Fixed #3 Mil Ops >
tensor_transformationThe next PR provides the generated HTML.