✨ Render Rich markup as HTML in Markdown docs #847
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
svlandeg
commented
May 28, 2024
Comment on lines
+365
to
+367
| if rich is not None: | ||
| # This is needed for when we want to export to HTML | ||
| extra_str = rich.markup.escape(extra_str).strip() |
There was a problem hiding this comment.
This is the only bit that worries me a bit (here and L559) as this changes core functionality anytime get_help_record is called on an argument or an option. Existing tests initially failed in test_doc.py but I was able to remedy those by using highlight=False, overflow="ignore" and crop=False in the rich_to_html helper function.
Nevertheless @tiangolo, it would be good to get your eyes on this 🙏
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.
Fixes #819: ensure that Rich-formatted help texts get rendered properly in Markdown by using the Rich built-in
export_htmlfunctionality.I've expanded the example from #819 to ensure that the following are covered: Command help, Option help, Argument help, default value,
[required]flag.TODO
Double check whether existing functionality and printing behaviour has remained unchanged.