sphinx.util.console

module documentation
(source)

Format colored console output.

Function color_terminal Undocumented
Function colorize Undocumented
Function coloron Undocumented
Function create_color_func Undocumented
Function get_terminal_width Return the width of the terminal in columns.
Function nocolor Undocumented
Function strip_colors Undocumented
Function term_width_line Undocumented
Function terminal_safe Safely encode a string for printing to the terminal.
Variable codes Undocumented
Variable _ansi_re Undocumented
Variable _attrs Undocumented
Variable _colors Undocumented
Variable _orig_codes Undocumented
Variable _tw Undocumented
def color_terminal(): (source)

Undocumented

Returns
boolUndocumented
def colorize(name, text, input_mode=False): (source)

Undocumented

Parameters
name:strUndocumented
text:strUndocumented
input_mode:boolUndocumented
Returns
strUndocumented
def coloron(): (source)

Undocumented

def create_color_func(name): (source)

Undocumented

Parameters
name:strUndocumented
def get_terminal_width(): (source)

Return the width of the terminal in columns.

Returns
intUndocumented
def nocolor(): (source)

Undocumented

def strip_colors(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented
def term_width_line(text): (source)

Undocumented

Parameters
text:strUndocumented
Returns
strUndocumented
def terminal_safe(s): (source)

Safely encode a string for printing to the terminal.

Parameters
s:strUndocumented
Returns
strUndocumented
codes: dict[str, str] = (source)

Undocumented

_ansi_re: re.Pattern = (source)

Undocumented

_attrs: dict[str, str] = (source)

Undocumented

_colors: list = (source)

Undocumented

_orig_codes = (source)

Undocumented

_tw: int = (source)

Undocumented