Remove the math block's indentation from the API docs #1123
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
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
Eric-Arellano
approved these changes
Apr 4, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Turns out the math blocks (latex expressions between double dollars `$$`) can't be indented more than once without making the pages not render. After introducing the MDX components for classes, functions, and attributes on Qiskit#1026, we can't guarantee only one level of indentation, and this PR adds a new function to remove the indentation as a postprocess of all the MDX files. Example of a math expression that was not rendering before: 
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.
Turns out the math blocks (latex expressions between double dollars
$$) can't be indented more than once without making the pages not render. After introducing the MDX components for classes, functions, and attributes on #1026, we can't guarantee only one level of indentation, and this PR adds a new function to remove the indentation as a postprocess of all the MDX files.Example of a math expression that was not rendering before:
