diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:25:40 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:25:40 +0000 |
commit | cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a (patch) | |
tree | 18dcde1a8d1f5570a77cd0c361de3b490d02c789 /sphinx/writers/xml.py | |
parent | Initial commit. (diff) | |
download | sphinx-cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a.tar.xz sphinx-cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a.zip |
Adding upstream version 7.2.6.upstream/7.2.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'sphinx/writers/xml.py')
-rw-r--r-- | sphinx/writers/xml.py | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py new file mode 100644 index 0000000..38aa763 --- /dev/null +++ b/sphinx/writers/xml.py @@ -0,0 +1,52 @@ +"""Docutils-native XML and pseudo-XML writers.""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +from docutils.writers.docutils_xml import Writer as BaseXMLWriter + +if TYPE_CHECKING: + from sphinx.builders import Builder + + +class XMLWriter(BaseXMLWriter): + output: str + + 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: str + """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 |