artin/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2026-02-06 10:58:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1915 from paw-lu/document-stylesheet

Browse Source 
Document the need for '{stylesheet}' in `code_format` for HTML export
This commit is contained in:
Will McGugan 2022-02-11 11:13:24 +00:00 committed by GitHub
commit 60dadaf2c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
rich/console.py
View File

@ -2060,8 +2060,8 @@ class Console:
Args:
theme (TerminalTheme, optional): TerminalTheme object containing console colors.
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``.
code_format (str, optional): Format string to render HTML, should contain {foreground}
{background} and {code}.
code_format (str, optional): Format string to render HTML. In addition to '{foreground}',
'{background}', and '{code}', should contain '{stylesheet}' if inline_styles is ``False``.
inline_styles (bool, optional): If ``True`` styles will be inlined in to spans, which makes files
larger but easier to cut and paste markup. If ``False``, styles will be embedded in a style tag.
Defaults to False.
@ -2137,8 +2137,8 @@ class Console:
path (str): Path to write html file.
theme (TerminalTheme, optional): TerminalTheme object containing console colors.
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``.
code_format (str, optional): Format string to render HTML, should contain {foreground}
{background} and {code}.
code_format (str, optional): Format string to render HTML. In addition to '{foreground}',
'{background}', and '{code}', should contain '{stylesheet}' if inline_styles is ``False``.
inline_styles (bool, optional): If ``True`` styles will be inlined in to spans, which makes files
larger but easier to cut and paste markup. If ``False``, styles will be embedded in a style tag.
Defaults to False.