changelog.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. .. _changelog:
  2. =========
  3. Changelog
  4. =========
  5. Version 0.2
  6. ===========
  7. Version 0.2.4 (2020-08-12)
  8. --------------------------
  9. * Skip file existence check for the :file:`.` directory. This fixes an issue if the configuration or source directory is in the local path but reported as missing, because ``git cat-file -e`` always reports an error in that case. (`#12 <issue12_>`_)
  10. * Fix file existence check not working on Windows. (`#18 <issue18_>`_, `#19 <issue19_>`_)
  11. * Fix bug in the sphinx extension which tried to load the `conf.py` from the source directory instead of the conf directory. This could lead to problems when the two directories differ. (`#11 <issue11_>`_, `#13 <issue13_>`_)
  12. * Fix wrong import in :file:`__main__.py` that prevented invocation using ``python -m sphinx_multiversion``. (`#23 <issue23_>`_)
  13. * Fix failure to find refs if ``sphinx-multiversion`` was not invoked from the root of the git repository. (`#24 <issue24_>`_, `#25 <issue25_>`_, `#26 <issue26_>`_)
  14. * 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. Python's `interpreter flags <pythonflags_>`_ (e.g. isolated mode) are passed through to the subprocesses. (`#22 <issue22_>`_, `#28 <issue28_>`_, `#30 <issue30_>`_, `#36 <issue36_>`_)
  15. * 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_>`_)
  16. Version 0.2.3 (2020-05-04)
  17. --------------------------
  18. * Fixed return codes of main() function and exit with non-zero status if no matching refs were found.
  19. * Added some logging calls to the git module.
  20. * Fixed bug where local branch was used to check the existence of files on remote branches.
  21. Version 0.2.2 (2020-05-01)
  22. --------------------------
  23. * Added additional checks to determine if a branch or tag contains both the Sphinx source directory and the :file:`conf.py` file. If that's not the case, that branch or tag is skipped automatically and not copied to the temporary directory. (`#9 <issue9_>`_)
  24. Version 0.2.1 (2020-04-19)
  25. --------------------------
  26. * Fixed handling of absolute output paths in `vpathto` and ensure that all generated paths are relative.
  27. Version 0.2.0 (2020-04-19)
  28. --------------------------
  29. * Added a way to override config variables using placeholders that expand to each version's actual value (`#4 <issue4_>`_, `#7 <issue7_>`_).
  30. Version 0.1
  31. ===========
  32. Version 0.1.1 (2020-03-12)
  33. --------------------------
  34. * Fixed version number in documentation
  35. * Fixed issue that caused the wrong configuration directory being used when the ``-c`` argument was not specified on the command line
  36. Version 0.1.0 (2020-03-11)
  37. --------------------------
  38. * Initial release
  39. .. _issue4: https://github.com/Holzhaus/sphinx-multiversion/issues/4
  40. .. _issue7: https://github.com/Holzhaus/sphinx-multiversion/issues/7
  41. .. _issue9: https://github.com/Holzhaus/sphinx-multiversion/issues/9
  42. .. _issue11: https://github.com/Holzhaus/sphinx-multiversion/issues/11
  43. .. _issue12: https://github.com/Holzhaus/sphinx-multiversion/issues/12
  44. .. _issue13: https://github.com/Holzhaus/sphinx-multiversion/issues/13
  45. .. _issue18: https://github.com/Holzhaus/sphinx-multiversion/issues/18
  46. .. _issue19: https://github.com/Holzhaus/sphinx-multiversion/issues/19
  47. .. _issue22: https://github.com/Holzhaus/sphinx-multiversion/issues/22
  48. .. _issue23: https://github.com/Holzhaus/sphinx-multiversion/issues/23
  49. .. _issue24: https://github.com/Holzhaus/sphinx-multiversion/issues/24
  50. .. _issue25: https://github.com/Holzhaus/sphinx-multiversion/issues/25
  51. .. _issue26: https://github.com/Holzhaus/sphinx-multiversion/issues/26
  52. .. _issue28: https://github.com/Holzhaus/sphinx-multiversion/issues/28
  53. .. _issue30: https://github.com/Holzhaus/sphinx-multiversion/issues/30
  54. .. _issue31: https://github.com/Holzhaus/sphinx-multiversion/issues/31
  55. .. _issue35: https://github.com/Holzhaus/sphinx-multiversion/issues/35
  56. .. _issue36: https://github.com/Holzhaus/sphinx-multiversion/issues/36
  57. .. _pythonflags: https://docs.python.org/3/using/cmdline.html#miscellaneous-options