-
-
Notifications
You must be signed in to change notification settings - Fork 672
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✨ Render Rich markup as HTML in Markdown docs #847
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, thank you! 🚀 🙇
Just for completeness, extra info: I'm not sure what changed, maybe it was something in a recent release in Rich, because tests were passing here before merging, but then they were no longer passing 😅 I changed it here: #1055, it was about how to capture and render the Rich console. |
The `rich` module should be set to `None`, indicating that rich should not be used. Setting it to `False` worked before, but recently added code in typer fails when checking `if rich is not None`. ref: fastapi/typer#847
The `rich` module should be set to `None`, indicating that rich should not be used. Setting it to `False` worked before, but recently added code in typer fails when checking `if rich is not None`. ref: fastapi/typer#847
The `rich` module should be set to `None`, indicating that rich should not be used. Setting it to `False` worked before, but recently added code in typer fails when checking `if rich is not None`. ref: fastapi/typer#847
Fixes #819: ensure that Rich-formatted help texts get rendered properly in Markdown by using the Rich built-in
export_html
functionality.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.