Changelog

Version 0.2

Version 0.2.5 (unreleased)

• Add support for version dependent RST prolog. (#51)

• Fix various mistakes in the documentation. (#52, #53, #55, #73)

• Move Git repository to sphinx-contrib/multiversion.

• Switch CI to GitHub Actions and fix various code issues. (#54, #117, #118)

Version 0.2.4 (2020-08-12)

• Skip file existence check for the . 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)

• Fix file existence check not working on Windows. (#18, #19)

• 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, #13)

• Fix wrong import in __main__.py that prevented invocation using python -m sphinx_multiversion. (#23)

• Fix failure to find refs if sphinx-multiversion was not invoked from the root of the git repository. (#24, #25, #26)

• Resolve issues with Sphinx extensions and Python modules not being reloaded when parsing the different 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 (e.g. isolated mode) are passed through to the subprocesses. (#22, #28, #30, #36)

• 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, #35)

Version 0.2.3 (2020-05-04)

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

• Added some logging calls to the git module.

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

Version 0.2.2 (2020-05-01)

• Added additional checks to determine if a branch or tag contains both the Sphinx source directory and the conf.py file. If that’s not the case, that branch or tag is skipped automatically and not copied to the temporary directory. (#9)

Version 0.2.1 (2020-04-19)

• Fixed handling of absolute output paths in vpathto and ensure that all generated paths are relative.

Version 0.2.0 (2020-04-19)

• Added a way to override config variables using placeholders that expand to each version’s actual value (#4, #7).

Version 0.1

Version 0.1.1 (2020-03-12)

• Fixed version number in documentation

• Fixed issue that caused the wrong configuration directory being used when the -c argument was not specified on the command line

Version 0.1.0 (2020-03-11)

• Initial release