v2.6.0

What's Changed

• 🔧 MAINT: Fix deprecated sphinx.testing.path by @jdillard in #83
• 🔧 MAINT: Declare 'dependencies' as 'dynamic' by @penguinpee in #84
• ✨ NEW: Add sitemap_excludes configuration by @jdillard in #91

New Contributors

• @dependabot made their first contribution in #74
• @penguinpee made their first contribution in #84

Full Changelog: v2.5.1...v2.6.0

Release 2.5.1 (2023-08-17)

Install from PyPi

What's Changed

• 🐛 FIX: Fix incremental building by preventing multiprocessing queue from being pickled with environment by @bstrdsmkr in #62
• 🔧 MAINT: Add docstrings and type hints by @jdillard in #61
• 🐛 FIX: Fix Path use for Sphinx 7.2 by @larsoner in #70

New Contributors

• @bstrdsmkr made their first contribution in #62
• @pre-commit-ci made their first contribution in #63
• @larsoner made their first contribution in #70

Full Changelog: v2.5.0...v2.5.1

Release 2.5.0 (2023-01-28)

Install from PyPi

What's Changed

• 📚 DOCS: Calculate version for sitemap based on current tag by @jdillard in #53
• 🔧 MAINT: Add changelog to project.urls by @jdillard in #54
• 🧪 TESTS: Add Sphinx 6 environment to tox by @jdillard in #55
• ✨ NEW: Add support for Sphinx config html_file_suffix by @jdetaeye in #57
• 📚 DOCS: Add site search optimization by @jdillard in #58

New Contributors

• @jdetaeye made their first contribution in #57

Full Changelog: v2.4.0...v2.5.0

Release 2.4.0 (2022-12-26)

Install from PyPi

What's Changed

• 🧪 TESTS: Add python 3.11 tests by @jdillard in #43
• 📚 DOCS: Add ReadTheDocs docs by @jdillard in #45
• 🔧 MAINT: General code clean up by @jdillard in #46
• ✨ NEW: Add support for parallel mode by @jdillard in #47
• 🧪 TESTS: Add tests for dirhtml builder by @jdillard in #48
• 📚 DOCS: Add vale support for docs by @jdillard in #49
• 🐛 FIX: Fix wheel includes so they don't include docs and tests by @jdillard in #51
• 📚 DOCS: Add write-good and improve writing by @jdillard in #52

Shout-out to @xmo-odoo in #47

Full Changelog: v2.3.0...v2.4.0

Release 2.3.0 (2022-12-21)

Install from PyPi

What's Changed

• 🔧 MAINT: Clean up how package versions are handled by @jdillard in #34
• 🔧 MAINT: Install pre-commit with isort, black, and flake8 by @jdillard in #35
• 📚 DOCS: Improve the wording of the README by @jdillard in #36
• 🐛 FIX: Follow correct format for multilingual sitemaps by @jdillard in #38
• 🔧 MAINT: Update the build process and provide wheels by @jdillard in #39
• 🔧 MAINT: Add testing infrastructure by @jdillard in #41
• 🔧 MAINT: Add python 3.10 tests and remove flake8 test from tox by @jdillard in #42
• 🐛 FIX: Use logging for all logging messages by @jdillard in #40

Full Changelog: v2.2.1...v2.3.0

Release 2.2.1 (2022-11-11)

Install from PyPi

What's Changed

• 🐛 FIX: sitemap_url_scheme default value in README file by @DelazJ in #32
• 🔧 MAINTAIN: Clean up package classifiers
• 🔧 MAINTAIN: Add LICENSE to source distributions by @bollwyvl #27
• 🔧 MAINTAIN: Add Conda Forge badge to README file

New Contributors

• @bollwyvl made their first contribution in #27
• @DelazJ made their first contribution in #32

Full Changelog: v2.2.0...v2.2.1

Release 2.2.0 (2020-08-05)

Install from PyPi

What's Changed

• ✨ NEW: Add sitemap_locales config value that creates an allow list of locales by @mattwarrick in #25
• ✨ NEW: Add sitemap_filename config value that allows for custom sitemap name by @SabotageAndi in #26
• 🔧 MAINTAIN: Add parallel_write_safe flag and set to False (addresses #20)

New Contributors

• @SabotageAndi made their first contribution in #26
• @mattwarrick made their first contribution in #25

Full Changelog: v2.1.0...v2.2.0

Release 2.1.0 (2020-02-22)

Install from PyPi

What's Changed

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

Full Changelog: v2.0.0...v2.1.0

Release 2.0.0 (2020-02-19)

Install from PyPi

What's Changed

• ✨ NEW: Add sitemap_url_scheme config value that allows the url scheme to be customized with a default of {version}{lang}{link} by @mart-e in #23

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.

New Contributors

• @mart-e made their first contribution in #23

Full Changelog: v1.1.0...v2.0.0

Release 1.1.0 (2019-12-12)

Install from PyPi

What's Changed

• ✨ NEW: Add support for DirectoryHTMLBuilder by @ruksi in #21
• ✨ NEW: Make version and language config values each optional.
• 🐛 FIX: Mark unsafe for parallel reading.
• 🔧 MAINTAIN: Remove unused HTMLTranslator import.
• 🔧 MAINTAIN: Add license to setup.py.

New Contributors

• @ruksi made their first contribution in #21

Full Changelog: v1.0.2...v1.1.0