RTD: Re-enable showing version text underneath logo

[joshuacwnewton]

Related Issues/PRs

Fixes #3015. (#3015 (comment))

[jcohenadad]

Currently it is showing the PR number, we need to fetch the version.txt from the release branch, I think.

[joshuacwnewton]

Currently it is showing the PR number, we need to fetch the version.txt from the release branch, I think.

That's because RTD is generating the docs from the PR, so in this case, the version is the PR number. It's similar to the warning:

This page was created from a pull request.

If this were merged, then the version would display as latest, stable, 5.0.0, etc. depending on the version selected on RTD. (Same as https://ivadomed.org)

[jcohenadad]

@joshuacwnewton thank you for the clarification, i thought that "stable" was not displayed, but instead would show the latest stable version. It is clearer now.

Just to be sure: how are "latest" and "stable" defined? Is it a feature in RTD that would automatically link "latest" with master (or the new "main"), and "stable" with the latest release?

[joshuacwnewton]

Just to be sure: how are "latest" and "stable" defined? Is it a feature in RTD that would automatically link "latest" with master (or the new "main"), and "stable" with the latest release?

Yes, precisely. latest is set using a drop-down menu:

For stable, From How we envision versions working:

You should push a tag for each version of your project. These tags should be numbered in a way that is consistent with semantic versioning. This will map to your stable branch by default.

We in fact are parsing your tag names against the rules given by PEP 440. This spec allows “normal” version numbers like 1.4.2 as well as pre-releases. An alpha version or a release candidate are examples of pre-releases and they look like this: 2.0a1.

We only consider non pre-releases for the stable version of your documentation.