changelog.rst 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .. _changelog:
  2. =========
  3. Changelog
  4. =========
  5. Version 0.2
  6. ===========
  7. Version 0.2.4 (unreleased)
  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. (`#22 <issue22_>`_, `#28 <issue28_>`_, `#30 <issue30_>`_)
  15. Version 0.2.3
  16. -------------
  17. * Fixed return codes of main() function and exit with non-zero status if no matching refs were found.
  18. * Added some logging calls to the git module.
  19. * Fixed bug where local branch was used to check the existence of files on remote branches.
  20. Version 0.2.2
  21. -------------
  22. * 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_>`_)
  23. Version 0.2.1
  24. -------------
  25. * Fixed handling of absolute output paths in `vpathto` and ensure that all generated paths are relative.
  26. Version 0.2.0
  27. -------------
  28. * Added a way to override config variables using placeholders that expand to each version's actual value (`#4 <issue4_>`_, `#7 <issue7_>`_).
  29. Version 0.1
  30. ===========
  31. Version 0.1.1
  32. -------------
  33. * Fixed version number in documentation
  34. * Fixed issue that caused the wrong configuration directory being used when the ``-c`` argument was not specified on the command line
  35. Version 0.1.0
  36. -------------
  37. * Initial release
  38. .. _issue4: https://github.com/Holzhaus/sphinx-multiversion/issues/4
  39. .. _issue7: https://github.com/Holzhaus/sphinx-multiversion/issues/7
  40. .. _issue9: https://github.com/Holzhaus/sphinx-multiversion/issues/9
  41. .. _issue11: https://github.com/Holzhaus/sphinx-multiversion/issues/11
  42. .. _issue12: https://github.com/Holzhaus/sphinx-multiversion/issues/12
  43. .. _issue13: https://github.com/Holzhaus/sphinx-multiversion/issues/13
  44. .. _issue18: https://github.com/Holzhaus/sphinx-multiversion/issues/18
  45. .. _issue19: https://github.com/Holzhaus/sphinx-multiversion/issues/19
  46. .. _issue22: https://github.com/Holzhaus/sphinx-multiversion/issues/22
  47. .. _issue23: https://github.com/Holzhaus/sphinx-multiversion/issues/23
  48. .. _issue24: https://github.com/Holzhaus/sphinx-multiversion/issues/24
  49. .. _issue25: https://github.com/Holzhaus/sphinx-multiversion/issues/25
  50. .. _issue26: https://github.com/Holzhaus/sphinx-multiversion/issues/26
  51. .. _issue28: https://github.com/Holzhaus/sphinx-multiversion/issues/28
  52. .. _issue30: https://github.com/Holzhaus/sphinx-multiversion/issues/30