pip._vendor.pygments.sphinxext.PygmentsDoc Class Reference

Inheritance diagram for pip._vendor.pygments.sphinxext.PygmentsDoc:

Collaboration diagram for pip._vendor.pygments.sphinxext.PygmentsDoc:

Public Member Functions
	run (self)
	document_lexers_overview (self)
	document_lexers (self)
	document_formatters (self)
	document_filters (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
	filenames
	state
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
bool	has_content = False
int	required_arguments = 1
int	optional_arguments = 0
bool	final_argument_whitespace = False
dict	option_spec = {}
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

A directive to collect all lexers/formatters/filters and generate
autoclass directives for them.

Member Function Documentation

document_lexers_overview()

pip._vendor.pygments.sphinxext.PygmentsDoc.document_lexers_overview

(

self

)

Generate a tabular overview of all lexers.

The columns are the lexer name, the extensions handled by this lexer
(or "None"), the aliases and a link to the lexer class.

run()

pip._vendor.pygments.sphinxext.PygmentsDoc.run

(

self

)

Reimplemented from docutils.parsers.rst.Directive.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pygments/sphinxext.py