docutils.parsers.rst.directives.misc.Unicode Class Reference

Inheritance diagram for docutils.parsers.rst.directives.misc.Unicode:

Collaboration diagram for docutils.parsers.rst.directives.misc.Unicode:

Public Member Functions
	run (self)
Public Member Functions inherited from docutils.parsers.rst.Directive
	__init__ (self, name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
	directive_error (self, level, message)
	debug (self, message)
	info (self, message)
	warning (self, message)
	error (self, message)
	severe (self, message)
	assert_has_content (self)
	add_name (self, node)

Public Attributes
	state
	name
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
int	required_arguments = 1
int	optional_arguments = 0
bool	final_argument_whitespace = True
dict	option_spec
	comment_pattern = re.compile(r'( |\n|^)\.\. ')
Static Public Attributes inherited from docutils.parsers.rst.Directive
int	required_arguments = 0
int	optional_arguments = 0
bool	final_argument_whitespace = False
	option_spec = None
bool	has_content = False

Detailed Description

Convert Unicode character codes (numbers) to characters.  Codes may be
decimal numbers, hexadecimal numbers (prefixed by ``0x``, ``x``, ``\x``,
``U+``, ``u``, or ``\u``; e.g. ``U+262E``), or XML-style numeric character
entities (e.g. ``☮``).  Text following ".." is a comment and is
ignored.  Spaces are ignored, and any other text remains as-is.

Member Function Documentation

run()

docutils.parsers.rst.directives.misc.Unicode.run

(

self

)

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict docutils.parsers.rst.directives.misc.Unicode.option_spec

static

Initial value:

=  {'trim': directives.flag,
                   'ltrim': directives.flag,
                   'rtrim': directives.flag}

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/directives/misc.py