sphinx.util.console

module documentation

Format colored console output.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable codes Undocumented
Variable colorama Undocumented
Function color​_terminal Undocumented
Function colorize Undocumented
Function coloron Undocumented
Function create​_color​_func Undocumented
Function get​_terminal​_width Borrowed from the py lib.
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 ​_ansi​_re Undocumented
Variable ​_attrs Undocumented
Variable ​_colors Undocumented
Variable ​_orig​_codes Undocumented
Variable ​_tw Undocumented
codes: Dict[str, str] =

Undocumented

colorama =

Undocumented

def color_terminal():

Undocumented

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

Undocumented

Parameters
name:strUndocumented
text:strUndocumented
input​_mode:boolUndocumented
Returns
strUndocumented
def coloron():

Undocumented

def create_color_func(name):

Undocumented

Parameters
name:strUndocumented
def get_terminal_width():
Borrowed from the py lib.
Returns
intUndocumented
def nocolor():

Undocumented

def strip_colors(s):

Undocumented

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

Undocumented

Parameters
text:strUndocumented
Returns
strUndocumented
def terminal_safe(s):
Safely encode a string for printing to the terminal.
Parameters
s:strUndocumented
Returns
strUndocumented
_ansi_re: Pattern =

Undocumented

_attrs: dict[str, str] =

Undocumented

_colors: list =

Undocumented

_orig_codes =

Undocumented

_tw: int =

Undocumented