docutils.writers.pep_html.Writer Class Reference

Inheritance diagram for docutils.writers.pep_html.Writer:

Collaboration diagram for docutils.writers.pep_html.Writer:

Public Member Functions
	__init__ (self)
	interpolation_dict (self)
	assemble_parts (self)
Public Member Functions inherited from docutils.writers._html_base.Writer
	get_transforms (self)
	translate (self)
	apply_template (self)
Public Member Functions inherited from docutils.writers.Writer
	write (self, document, destination)
Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	translator_class
	pepnum
	title
	body
Public Attributes inherited from docutils.writers.html4css1.Writer
	parts
	translator_class
Public Attributes inherited from docutils.writers._html_base.Writer
	visitor
	output
Public Attributes inherited from docutils.writers.Writer
	parts
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
str	default_stylesheet = 'pep.css'
	default_stylesheet_path
str	default_template = 'template.txt'
	default_template_path
	settings_spec
dict	settings_default_overrides
tuple	relative_path_settings = ('template',)
str	config_section = 'pep_html writer'
tuple	config_section_dependencies
Static Public Attributes inherited from docutils.writers.html4css1.Writer
tuple	supported = ('html', 'html4', 'html4css1', 'xhtml', 'xhtml10')
list	default_stylesheets = ['html4css1.css']
list	default_stylesheet_dirs
	default_template
	settings_spec
str	config_section = 'html4css1 writer'
Static Public Attributes inherited from docutils.writers._html_base.Writer
tuple	supported = ('html', 'xhtml')
tuple	settings_spec
dict	settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'}
tuple	relative_path_settings = ('template',)
str	config_section = 'html base writer'
tuple	config_section_dependencies = ('writers', 'html writers')
tuple	visitor_attributes
Static Public Attributes inherited from docutils.writers.Writer
str	component_type = 'writer'
str	config_section = 'writers'
	document = None
	output = None
	language = None
	destination = None
Static Public Attributes inherited from docutils.Component
	component_type = None
tuple	supported = ()
Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()
	settings_defaults = None
	settings_default_overrides = None
tuple	relative_path_settings = ()
	config_section = None
	config_section_dependencies = None
Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()
tuple	unknown_reference_resolvers = ()

Constructor & Destructor Documentation

__init__()

docutils.writers.pep_html.Writer.__init__

(

self

)

Reimplemented from docutils.writers.html4css1.Writer.

Member Function Documentation

assemble_parts()

docutils.writers.pep_html.Writer.assemble_parts

(

self

)

Assemble the `self.parts` dictionary.  Extend in subclasses.

See <https://docutils.sourceforge.io/docs/api/publisher.html>.

Reimplemented from docutils.writers._html_base.Writer.

interpolation_dict()

docutils.writers.pep_html.Writer.interpolation_dict

(

self

)

Reimplemented from docutils.writers._html_base.Writer.

Member Data Documentation

config_section_dependencies

tuple docutils.writers.pep_html.Writer.config_section_dependencies

static

Initial value:

=  ('writers', 'html writers',
                                   'html4css1 writer')

default_stylesheet_path

docutils.writers.pep_html.Writer.default_stylesheet_path

static

Initial value:

=  utils.relative_path(
        os.path.join(os.getcwd(), 'dummy'),
        os.path.join(os.path.dirname(__file__), default_stylesheet))

default_template_path

docutils.writers.pep_html.Writer.default_template_path

static

Initial value:

=  utils.relative_path(
        os.path.join(os.getcwd(), 'dummy'),
        os.path.join(os.path.dirname(__file__), default_template))

settings_default_overrides

dict docutils.writers.pep_html.Writer.settings_default_overrides

static

Initial value:

=  {'stylesheet_path': default_stylesheet_path,
                                  'template': default_template_path}

settings_spec

docutils.writers.pep_html.Writer.settings_spec

static

Initial value:

=  html4css1.Writer.settings_spec + (
        'PEP/HTML Writer Options',
        'For the PEP/HTML writer, the default value for the --stylesheet-path '
        'option is "%s", and the default value for --template is "%s". '
        'See HTML Writer Options above.'
        % (default_stylesheet_path, default_template_path),
        (('Python\'s home URL.  Default is "https://www.python.org".',
          ['--python-home'],
          {'default': 'https://www.python.org', 'metavar': '<URL>'}),
         ('Home URL prefix for PEPs.  Default is "." (current directory).',
          ['--pep-home'],
          {'default': '.', 'metavar': '<URL>'}),
         # For testing.
         (frontend.SUPPRESS_HELP,
          ['--no-random'],
          {'action': 'store_true', 'validator': frontend.validate_boolean}),))

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/writers/pep_html/__init__.py