myst_parser.warnings_ Namespace Reference

Classes
class	MystWarnings

Functions
bool	_is_suppressed_warning (str type, str subtype, Sequence[str] suppress_warnings)
nodes.system_message|None	create_warning (nodes.document document, str message, MystWarnings|str subtype, *str|None wtype=None, nodes.Element|None node=None, int|None line=None, nodes.Element|None append_to=None)
nodes.system_message	_create_warning_node (str msg, str source, int|None line)

Detailed Description

Central handling of warnings for the myst extension.

Function Documentation

_is_suppressed_warning()

bool myst_parser.warnings_._is_suppressed_warning ( str  type, str  subtype, Sequence[str]   suppress_warnings  )

protected

Check whether the warning is suppressed or not.

Mirrors:
https://github.com/sphinx-doc/sphinx/blob/47d9035bca9e83d6db30a0726a02dc9265bd66b1/sphinx/util/logging.py

create_warning()

nodes.system_message | None myst_parser.warnings_.create_warning	(	nodes.document	document,
		str	message,
		MystWarnings | str	subtype,
		*str | None	wtype = None,
		nodes.Element | None	node = None,
		int | None	line = None,
		nodes.Element | None	append_to = None
	)

Generate a warning, logging if it is necessary.

If the warning type is listed in the ``suppress_warnings`` configuration,
then ``None`` will be returned and no warning logged.