Sphinx-sitemap

------

*Release date: 2020-08-05*

* |:wrench:| MAINT: Add ``parallel_write_safe`` flag and set to `False`
`20 <https://github.com/jdillard/sphinx-sitemap/issues/20>`_.
* |:sparkles:| Add :confval:`sitemap_locales` that creates an allow list of locales
`25 <https://github.com/jdillard/sphinx-sitemap/pull/25>`_.
* |:sparkles:| Add :confval:`sitemap_filename` that allows for custom sitemap name
`26 <https://github.com/jdillard/sphinx-sitemap/pull/26>`_.

-----

*Release date: 2020-02-22*

* |:bug:| FIX: Make sure the regional variants for the ``hreflang`` attribute are valid
`19 <https://github.com/jdillard/sphinx-sitemap/issues/19>`_.

-----

*Release date: 2020-02-19*

* |:sparkles:| NEW: Add :confval:`sitemap_url_scheme` that allows the URL scheme to be customized with a default of ``{version}{lang}{link}``
`22 <https://github.com/jdillard/sphinx-sitemap/issues/22>`_.

.. note:: This has the potential to be a breaking change depending on how the ``version`` and ``language`` values are set. **Confirm the accuracy of the sitemap after upgrading**.

-----

*Release date: 2019-12-12*

* |:sparkles:| NEW: Add support for ``DirectoryHTMLBuilder``.
* |:wrench:| MAINT: Remove unused ``HTMLTranslator`` import.
* |:sparkles:| NEW: Make ``version`` and ``language`` each optional.
* |:wrench:| MAINT: Add license to **setup.py**.
* |:wrench:| MAINT: Mark unsafe for parallel reading.

-----

*Release date: 2019-02-09*

* |:wrench:| MAINT: Add ``html_baseurl`` if it doesn't exist for sphinx versions prior to 1.8.0.

-----

*Release date: 2019-01-17*

* |:bug:| FIX: Fix for ``AttributeError: No such config value: html_baseurl`` on versions of sphinx older than 1.8.0.