myst_parser.parsers.parse_html.Comment Class Reference

Inheritance diagram for myst_parser.parsers.parse_html.Comment:

Collaboration diagram for myst_parser.parsers.parse_html.Comment:

Public Member Functions
str	render (self, **kwargs)
Public Member Functions inherited from myst_parser.parsers.parse_html.TerminalElement
	__init__ (self, str data)
str	__repr__ (self)
TerminalElement	deepcopy (self)
Public Member Functions inherited from myst_parser.parsers.parse_html.Element
Element|None	parent (self)
list[Element]	children (self)
	reset_children (self, list[Element] children, bool deepcopy=False)
Element	__getitem__ (self, int index)
	__setitem__ (self, int index, Element item)
	__delitem__ (self, int index)
int	__len__ (self)
Iterator[Element]	__iter__ (self)
	insert (self, int index, Element item)
str	__str__ (self)
bool	__eq__ (self, Any item)
Iterator[Element]	walk (self, bool include_self=False)
Element	strip (self, bool inplace=False, bool recurse=False)
Iterator[Element]	find (self, str|type[Element] identifier, dict|None attrs=None, Iterable[str]|None classes=None, bool include_self=False, bool recurse=True)

Additional Inherited Members
Public Attributes inherited from myst_parser.parsers.parse_html.Element
	name
Protected Attributes inherited from myst_parser.parsers.parse_html.Element
	_children

Detailed Description

Represent HTML comments

Member Function Documentation

render()

str myst_parser.parsers.parse_html.Comment.render	(		self,
		**	tag_overrides
	)

Returns a HTML string representation of the element.

:param tag_overrides: Provide a dictionary of render function
    for specific tag names, to override the normal render format

Reimplemented from myst_parser.parsers.parse_html.Element.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/parsers/parse_html.py