Startseite Erkunden Hilfe
Anmelden
DragonOS-Community
/
sphinx-multiversion
Mirror von https://github.com/DragonOS-Community/sphinx-multiversion
4
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 9742ccd723
Branches Tags
sphinx-multiver...
/
docs
/
changelog.rst

changelog.rst 3.9 KB
Verlauf Originalformat

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 
  1. .. _changelog:
    2. 

  2. 

  3. =========
    4. 

  4. Changelog
    5. 

  5. =========
    6. 

  6. 

  7. Version 0.2
    8. 

  8. ===========
    9. 

  9. 

  10. Version 0.2.4 (unreleased)
    11. 

  11. --------------------------
    12. 

  12. 

  13. * 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_>`_)
    14. 

  14. * Fix file existence check not working on Windows. (`#18 <issue18_>`_, `#19 <issue19_>`_)
    15. 

  15. * 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_>`_)
    16. 

  16. * Fix wrong import in :file:`__main__.py` that prevented invocation using ``python -m sphinx_multiversion``. (`#23 <issue23_>`_)
    17. 

  17. * Fix failure to find refs if ``sphinx-multiversion`` was not invoked from the root of the git repository. (`#24 <issue24_>`_, `#25 <issue25_>`_, `#26 <issue26_>`_)
    18. 

  18. * 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_>`_)
    19. 

  19. * 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_>`_)
    20. 

  20. 

  21. 

  22. Version 0.2.3
    23. 

  23. -------------
    24. 

  24. 

  25. * Fixed return codes of main() function and exit with non-zero status if no matching refs were found.
    26. 

  26. * Added some logging calls to the git module.
    27. 

  27. * Fixed bug where local branch was used to check the existence of files on remote branches.
    28. 

  28. 

  29. 

  30. Version 0.2.2
    31. 

  31. -------------
    32. 

  32. 

  33. * 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_>`_)
    34. 

  34. 

  35. 

  36. Version 0.2.1
    37. 

  37. -------------
    38. 

  38. 

  39. * Fixed handling of absolute output paths in `vpathto` and ensure that all generated paths are relative.
    40. 

  40. 

  41. 

  42. Version 0.2.0
    43. 

  43. -------------
    44. 

  44. 

  45. * Added a way to override config variables using placeholders that expand to each version's actual value (`#4 <issue4_>`_, `#7 <issue7_>`_).
    46. 

  46. 

  47. 

  48. Version 0.1
    49. 

  49. ===========
    50. 

  50. 

  51. Version 0.1.1
    52. 

  52. -------------
    53. 

  53. 

  54. * Fixed version number in documentation
    55. 

  55. * Fixed issue that caused the wrong configuration directory being used when the ``-c`` argument was not specified on the command line
    56. 

  56. 

  57. Version 0.1.0
    58. 

  58. -------------
    59. 

  59. 

  60. * Initial release
    61. 

  61. 

  62. 

  63. .. _issue4: https://github.com/Holzhaus/sphinx-multiversion/issues/4
    64. 

  64. .. _issue7: https://github.com/Holzhaus/sphinx-multiversion/issues/7
    65. 

  65. .. _issue9: https://github.com/Holzhaus/sphinx-multiversion/issues/9
    66. 

  66. .. _issue11: https://github.com/Holzhaus/sphinx-multiversion/issues/11
    67. 

  67. .. _issue12: https://github.com/Holzhaus/sphinx-multiversion/issues/12
    68. 

  68. .. _issue13: https://github.com/Holzhaus/sphinx-multiversion/issues/13
    69. 

  69. .. _issue18: https://github.com/Holzhaus/sphinx-multiversion/issues/18
    70. 

  70. .. _issue19: https://github.com/Holzhaus/sphinx-multiversion/issues/19
    71. 

  71. .. _issue22: https://github.com/Holzhaus/sphinx-multiversion/issues/22
    72. 

  72. .. _issue23: https://github.com/Holzhaus/sphinx-multiversion/issues/23
    73. 

  73. .. _issue24: https://github.com/Holzhaus/sphinx-multiversion/issues/24
    74. 

  74. .. _issue25: https://github.com/Holzhaus/sphinx-multiversion/issues/25
    75. 

  75. .. _issue26: https://github.com/Holzhaus/sphinx-multiversion/issues/26
    76. 

  76. .. _issue28: https://github.com/Holzhaus/sphinx-multiversion/issues/28
    77. 

  77. .. _issue30: https://github.com/Holzhaus/sphinx-multiversion/issues/30
    78. 

  78. .. _issue31: https://github.com/Holzhaus/sphinx-multiversion/issues/31
    79. 

  79. .. _issue35: https://github.com/Holzhaus/sphinx-multiversion/issues/35
    80.