Browse Source

docs/changelog: Add changelog entry for Windows branch path fixes

Jan Holthuis 4 years ago
parent
commit
9742ccd723
1 changed files with 3 additions and 0 deletions
  1. 3 0
      docs/changelog.rst

+ 3 - 0
docs/changelog.rst

@@ -16,6 +16,7 @@ Version 0.2.4 (unreleased)
 * Fix wrong import in :file:`__main__.py` that prevented invocation using ``python -m sphinx_multiversion``. (`#23 <issue23_>`_)
 * Fix failure to find refs if ``sphinx-multiversion`` was not invoked from the root of the git repository. (`#24 <issue24_>`_, `#25 <issue25_>`_, `#26 <issue26_>`_)
 * Resolve issues with Sphinx extensions and Python modules not being reloaded when parsing the different :file:`conf.py` files. Now, each config file is parsed in it's own process, and the build is performed using the ``subprocess`` module instead of doing it all from the context of the main module. (`#22 <issue22_>`_, `#28 <issue28_>`_, `#30 <issue30_>`_)
+* Rewrite the path handling of the Sphinx extension to handle branch names containing a forward slash properly on Windows and add unittests and Windows CI builds to make sure it doesn't break on future updates. (`#31 <issue31_>`_, `#35 <issue35_>`_)
 
 
 Version 0.2.3
@@ -74,3 +75,5 @@ Version 0.1.0
 .. _issue26: https://github.com/Holzhaus/sphinx-multiversion/issues/26
 .. _issue28: https://github.com/Holzhaus/sphinx-multiversion/issues/28
 .. _issue30: https://github.com/Holzhaus/sphinx-multiversion/issues/30
+.. _issue31: https://github.com/Holzhaus/sphinx-multiversion/issues/31
+.. _issue35: https://github.com/Holzhaus/sphinx-multiversion/issues/35