pip._vendor.pygments.sphinxext Namespace Reference

Classes
class	PygmentsDoc

Functions
	setup (app)

Variables
str	MODULEDOC
str	LEXERDOC
str	FMTERDOC
str	FILTERDOC

Detailed Description

    pygments.sphinxext
    ~~~~~~~~~~~~~~~~~~

    Sphinx extension to generate automatic documentation of lexers,
    formatters and filters.

    :copyright: Copyright 2006-2023 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.

Variable Documentation

FILTERDOC

str pip._vendor.pygments.sphinxext.FILTERDOC

Initial value:

=  '''
.. class:: %s
 
    :Name: %s
 
    %s
 
'''

FMTERDOC

str pip._vendor.pygments.sphinxext.FMTERDOC

Initial value:

=  '''
.. class:: %s
 
    :Short names: %s
    :Filenames: %s
 
    %s
 
'''

LEXERDOC

str pip._vendor.pygments.sphinxext.LEXERDOC

Initial value:

=  '''
.. class:: %s
 
    :Short names: %s
    :Filenames:   %s
    :MIME types:  %s
 
    %s
 
'''

MODULEDOC

str pip._vendor.pygments.sphinxext.MODULEDOC

Initial value:

=  '''
.. module:: %s
 
%s
%s
'''