github_alerts Namespace Reference

Classes
class	GithubAlertsToAdmonitions

Functions
int	_convert_blockquotes (nodes.document doctree, *, bool debug=False)
	setup (app)

Variables
	_ALERT_HEADER = re.compile(r"^\s*\[\!(?P<kind>[A-Za-z]+)\]\s*(?P<title>.*)")
dict	_KIND_MAP
	logger = logging.getLogger(__name__)

Function Documentation

_convert_blockquotes()

int github_alerts._convert_blockquotes ( nodes.document doctree, * , bool debug = False )

protected

Convert GitHub alert blockquotes into admonitions. Returns count converted.

Definition at line 31 of file github_alerts.py.

setup()

github_alerts.setup

(

app

)

Definition at line 92 of file github_alerts.py.

Variable Documentation

_ALERT_HEADER

github_alerts._ALERT_HEADER = re.compile(r"^\s*\[\!(?P<kind>[A-Za-z]+)\]\s*(?P<title>.*)")

protected

Definition at line 13 of file github_alerts.py.

_KIND_MAP

dict github_alerts._KIND_MAP

protected

Initial value:

=  {
    "note": nodes.note,
    "tip": nodes.tip,
    "hint": nodes.hint,
    "important": nodes.important,
    "warning": nodes.warning,
    "caution": nodes.caution,
    "attention": nodes.attention,
    "danger": nodes.danger,
    "error": nodes.error,
    # Aliases
    "info": nodes.note,
    "success": nodes.tip,
}

Definition at line 16 of file github_alerts.py.

logger

github_alerts.logger = logging.getLogger(__name__)

Definition at line 7 of file github_alerts.py.