Add a configuration value to indent the output (aka prettify output) (#112)

Co-authored-by: Jared Dillard <[email protected]>

Author: julien-lecomte

CHANGELOG.rst

@@ -3,6 +3,12 @@
 Changelog
 =========
 
+2.9.0
+-----
+
+- |:sparkles:| NEW: Add :confval:`sitemap_indent` configuration value to control XML indentation
+  `#112 <https://github.com/jdillard/sphinx-sitemap/pull/112>`_
+
 2.8.0
 -----
 

docs/source/advanced-configuration.rst

@@ -180,3 +180,20 @@ This produces sitemap entries like:
 
 .. _sitemapindex.xml: https://support.google.com/webmasters/answer/75712?hl=en
 .. _sitemaps.org: https://www.sitemaps.org/protocol.html
+
+.. _configuration_indent:
+
+Formatting XML Output
+^^^^^^^^^^^^^^^^^^^^^
+
+To add indention to the XML output, set :confval:`sitemap_indent` to the number of spaces for indentation in **conf.py**:
+
+.. code-block:: python
+
+   sitemap_indent = 2
+
+Set to ``0`` (the default) to disable indentation:
+
+.. code-block:: python
+
+   sitemap_indent = 0

docs/source/configuration-values.rst

@@ -51,3 +51,12 @@ A list of of possible configuration values to configure in **conf.py**:
      See :ref:`configuration_lastmod` for more information.
 
    .. versionadded:: 2.7.0
+
+.. confval:: sitemap_indent
+
+   - **Type**: integer
+   - **Default**: ``0``
+   - **Description**: Number of spaces to use for indentation in the sitemap XML output.
+     See :ref:`configuration_indent` for more information.
+
+   .. versionadded:: 2.9.0

sphinx_sitemap/__init__.py

@@ -24,7 +24,7 @@
 from sphinx.errors import ExtensionError
 from sphinx.util.logging import getLogger
 
-__version__ = "2.8.0"
+__version__ = "2.9.0"
 
 logger = getLogger(__name__)
 
@@ -49,6 +49,8 @@ def setup(app: Sphinx) -> Dict[str, Any]:
 
     app.add_config_value("sitemap_show_lastmod", default=False, rebuild="")
 
+    app.add_config_value("sitemap_indent", default=0, rebuild="")
+
     try:
         app.add_config_value("html_baseurl", default=None, rebuild="")
     except BaseException:
@@ -258,6 +260,9 @@ def create_sitemap(app: Sphinx, exception):
             )
 
     filename = Path(app.outdir) / app.config.sitemap_filename
+    if isinstance(app.config.sitemap_indent, int) and app.config.sitemap_indent > 0:
+        ElementTree.indent(root, space=app.config.sitemap_indent * " ")
+
     ElementTree.ElementTree(root).write(
         filename, xml_declaration=True, encoding="utf-8", method="xml"
     )

tests/test_simple.py

@@ -215,3 +215,25 @@ def test_pattern_excludes(app, status, warning):
             "search",
         ]
     }
+
+
+@pytest.mark.sphinx(
+    "html",
+    freshenv=True,
+    confoverrides={
+        "html_baseurl": "https://example.org/docs/",
+        "language": "en",
+        "sitemap_indent": 2,
+    },
+)
+def test_indent(app, status, warning):
+    """Tests that xml output is indented"""
+    app.warningiserror = True
+    app.build()
+    assert "sitemap.xml" in os.listdir(app.outdir)
+    with open(app.outdir / "sitemap.xml", "r") as fd:
+        lines = fd.readlines()
+
+    assert lines[0][0] == "<"
+    assert lines[1][0] == "<"
+    assert lines[2][0:3] == "  <"