At the moment, the documentation links to examples on the main/default branch. This isn't right because the examples might change in between releases, potentially confusing users who are referring to the documentation. This PR fixes that problem by making the documentation use version-specific links i.e. for the 6.0.1 release, the 6.0.1 tag will be used instead of the main branch.
I tested this locally by checking the links generated in the built docs - the examples links will be broken as expected as the dev version has no corresponding tag on GitHub. I then hardcoded the version in the sphinx configuration to 6.0.1 and the links worked as expected, pointing to the 6.0.1 tree instead of main.
At the moment, the documentation links to examples on the
main/default branch. This isn't right because the examples might change in between releases, potentially confusing users who are referring to the documentation. This PR fixes that problem by making the documentation use version-specific links i.e. for the 6.0.1 release, the6.0.1tag will be used instead of themainbranch.I tested this locally by checking the links generated in the built docs - the examples links will be broken as expected as the dev version has no corresponding tag on GitHub. I then hardcoded the version in the sphinx configuration to
6.0.1and the links worked as expected, pointing to the6.0.1tree instead ofmain.