blob: f372db024ed72703d402f9335bc98d88b710de47 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
"""Docutils-native XML and pseudo-XML writers.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
from typing import Any
from docutils.writers.docutils_xml import Writer as BaseXMLWriter
from sphinx.builders import Builder
class XMLWriter(BaseXMLWriter):
def __init__(self, builder: Builder) -> None:
super().__init__()
self.builder = builder
# A lambda function to generate translator lazily
self.translator_class = lambda document: self.builder.create_translator(document)
def translate(self, *args: Any, **kwargs: Any) -> None:
self.document.settings.newlines = \
self.document.settings.indents = \
self.builder.env.config.xml_pretty
self.document.settings.xml_declaration = True
self.document.settings.doctype_declaration = True
return super().translate()
class PseudoXMLWriter(BaseXMLWriter):
supported = ('pprint', 'pformat', 'pseudoxml')
"""Formats this writer supports."""
config_section = 'pseudoxml writer'
config_section_dependencies = ('writers',)
output = None
"""Final translated form of `document`."""
def __init__(self, builder: Builder) -> None:
super().__init__()
self.builder = builder
def translate(self) -> None:
self.output = self.document.pformat()
def supports(self, format: str) -> bool:
"""This writer supports all format-specific elements."""
return True
|
