Fix doc source links for read the docs

[johnzielke]

Fixes the current docs build.
Currently no [source] links are shown anymore.
It seems like read the docs uses a different working directory, therefore breaking the source links. It also will not have the correct git tag referenced. This should fix both of these issues.

If there is a way to test if this fix works without merging to dev, let me know.

Description

A few sentences describing the changes proposed in this pull request.

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
• Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[KumoLiu]

If there is a way to test if this fix works without merging to dev, let me know.

A easy way may be cat one of the html in the job workflow to see whether the source link generated correctly.
https://github.com/Project-MONAI/MONAI/blob/dev/.github/workflows/pythonapp.yml#L238

[johnzielke]

The problem is that the github workflow and the read the docs workflow are not identical. Which is why this problem seems to have come up. The workflow in github/local execution seems to work fine, but the read the docs one uses a slightly different setup

[johnzielke]

Maybe enabling this might help recognize these issues in the future: https://docs.readthedocs.io/en/stable/pull-requests.html Although this still requires you to manually check the created build, if you make changes you can confirm that they also succeed in the read the docs build

[KumoLiu]

Hi @johnzielke, I'm considering reverting this PR for the 1.3.1 release and instead merging it into 1.4. I want to avoid any potential disruptions in the upcoming release. Thanks for understanding.

[KumoLiu]

/build

[KumoLiu]

/build

[johnzielke]

Hi @johnzielke, I'm considering reverting this PR for the 1.3.1 release and instead merging it into 1.4. I want to avoid any potential disruptions in the upcoming release. Thanks for understanding.

Hi @KumoLiu, it looks like it's working now. If you still end up doing that, I totally understand. I did setup my own read the docs to test, and it seems like the reference to stable versions/tags works as well and will then point to the commit of that version.