Changelog#

2.5.0#

Release date: 2023-01-28

  • 📚 DOCS: Calculate version for sitemap based on current tag #53

  • 🧪 TESTS: Add Sphinx 6 env to tox #55

  • ✨ NEW: Add support for Sphinx config “html_file_suffix” #57

  • 📚 DOCS: Add site search optimization #58

2.4.0#

Release date: 2022-12-26

  • 📚 DOCS: Add ReadTheDocs docs #45

  • 🔧 MAINT: General code clean up #46

  • ✨ NEW: Add support for parallel mode #47

  • 🧪 TESTS: Add tests for dirhtml builder #48

  • 🧪 TESTS: Add vale support for docs #49

  • 🐛 FIX: Fix wheel includes so they don’t include docs and tests #51

  • 📚 DOCS: Add write-good and improve writing #52

2.3.0#

Release date: 2022-12-21

  • 🔧 MAINT: Clean up how package versions are handled

  • 🧪 TESTS: Install pre-commit with isort, black, and flake8 #35

  • 📚 DOCS: Improve the wording of the README to help with issues upgrading to Sphinx 5 #36

  • 🐛 FIX: Follow correct format for multilingual sitemaps #38

  • 🔧 MAINT: Update the build process #39

  • 🧪 TESTS: Add testing infrastructure #41 #42

  • 🔧 MAINT: Use logging for all logging messages #40

2.2.1#

Release date: 2022-11-11

  • 📚 DOCS: Fix sitemap_url_scheme default value in README file #32

  • 🔧 MAINT: Clean up package classifiers

  • 🔧 MAINT: Add LICENSE to source distributions #27

  • 📚 DOCS: Add Conda Forge badge to README file

2.2.0#

Release date: 2020-08-05

2.1.0#

Release date: 2020-02-22

  • 🐛 FIX: Make sure the regional variants for the hreflang attribute are valid #19.

2.0.0#

Release date: 2020-02-19

  • ✨ NEW: Add sitemap_url_scheme that allows the URL scheme to be customized with a default of {version}{lang}{link} #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.

1.1.0#

Release date: 2019-12-12

  • ✨ NEW: Add support for DirectoryHTMLBuilder.

  • 🔧 MAINT: Remove unused HTMLTranslator import.

  • ✨ NEW: Make version and language each optional.

  • 🔧 MAINT: Add license to setup.py.

  • 🔧 MAINT: Mark unsafe for parallel reading.

1.0.2#

Release date: 2019-02-09

  • 🔧 MAINT: Add html_baseurl if it doesn’t exist for sphinx versions prior to 1.8.0.

1.0.1#

Release date: 2019-01-17

  • 🐛 FIX: Fix for AttributeError: No such config value: html_baseurl on versions of sphinx older than 1.8.0.

1.0.0#

Release date: 2019-01-17

  • 🔧 MAINT: Use native html_baseurl, instead of the custom site_url. It checks for both for backwards compatibility.

  • ✨ NEW: Add support for multiple languages.

0.3.1#

Release date: 2018-03-04

  • 📚 DOCS: Add instructions on maintaining PyPI version to the docs

0.3.0#

Release date: 2018-03-04

  • 🔧 MAINT: Remove unnecessary HTMLTranslator.

  • 📚 DOCS: Improve documentation

0.2#

Release date: 2017-11-28

  • 🔧 MAINT: Fix PyPI description

0.1#

Release date: 2017-11-28

  • Initial Release 🎉