Headings rework #423
Merged
Headings rework #423
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
mishig25
added a commit
to huggingface/transformers
that referenced
this pull request
Oct 4, 2023
mishig25
pushed a commit
to mishig25/trl
that referenced
this pull request
Oct 4, 2023
3 tasks
|
This could be responsible for docs CI job failing in We have a title with parenthesis in it |
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.
Description
Like #401, instead of having custom python regexes to deal with markdown headings, with this PR, we start using remark's already parsed tree for handling markdown headings. For the context, we do two transformations on markdown headings:
Issues being solved
Closes #343
Closes #193
Solved issue: render right side menu for non-english translated pages
Solved issue: support char
{inside headingsSolved issue: Fixes failing TRL doc build
Solved issue: strictly needing extra newline after heading
Performance
Besides solving the parsing issues, the build speed is faster since we are removing extra regex searches on python doc-builder side