pip._vendor.pygments.sphinxext Namespace Reference

Data Structures
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.

Function Documentation

setup()

setup

(

app

)

Definition at line 216 of file sphinxext.py.

def setup(app):
    app.add_directive('pygmentsdoc', PygmentsDoc)

References i.

Variable Documentation

FILTERDOC

str FILTERDOC

Initial value:

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

Definition at line 48 of file sphinxext.py.

FMTERDOC

str FMTERDOC

Initial value:

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

Definition at line 38 of file sphinxext.py.

LEXERDOC

str LEXERDOC

Initial value:

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

Definition at line 27 of file sphinxext.py.

MODULEDOC

str MODULEDOC

Initial value:

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

Definition at line 20 of file sphinxext.py.