Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make available all stable versions on RTD and display version number below logo #515

Closed
jcohenadad opened this issue Nov 10, 2020 · 11 comments
Assignees
Labels
documentation category: readthedocs or user doc

Comments

@jcohenadad
Copy link
Member

jcohenadad commented Nov 10, 2020

On RTD, we should be able to select stable releases:
image

Also, when selecting a stable release, the number should appear (instead of "stable"):
image

Also see spinalcordtoolbox/spinalcordtoolbox#3015 for more context and how-to

@jcohenadad jcohenadad added the documentation category: readthedocs or user doc label Nov 10, 2020
@alexfoias
Copy link
Contributor

alexfoias commented Nov 10, 2020

I triggered the builds for previous versions.

As for the stable release (the fact that we want the actual number), it's a feature that has been requested but not merged yet. readthedocs/readthedocs.org#4529

For the moment, the default version of the documentation is set to latest. Not sure if we want to change it to stable.

@jcohenadad
Copy link
Member Author

As for the stable release (the fact that we want the actual number), it's a feature that has been requested but not merged yet. readthedocs/readthedocs.org#4529

according to @joshuacwnewton it should work, see https://github.com/neuropoly/spinalcordtoolbox/pull/3021/files

@joshuacwnewton
Copy link
Member

joshuacwnewton commented Nov 11, 2020

according to @joshuacwnewton it should work, see https://github.com/neuropoly/spinalcordtoolbox/pull/3021/files

There may have been a miscommunication. That change just controls whether to show text at all (blank or stable/latest/etc.) It is already active for ivadomed:

"display_version": True,

Also, when selecting a stable release, the number should appear (instead of "stable"):

Just to clear things up, at SCT, we have this:

Screenshot from 2020-11-11 09-04-59

  • stable automatically fetches the latest stable version. It will display the text "stable" under the project logo.
  • 5.0.0 is a tag-based build that was manually activated. It will display the text "5.0.0" under the project logo.

Either can be set as the default, depending on preferences.

@jcohenadad
Copy link
Member Author

5.0.0 is a tag-based build that was manually activated. It will display the text "5.0.0" under the project logo.

this is exactly what we want for ivadomed

@alexfoias
Copy link
Contributor

so should we disable latest and stable and just keep the releases ?

@jcohenadad
Copy link
Member Author

latest --> master (we need to keep)
stable --> latest release (would be the default, we need to keep)

right @joshuacwnewton ?

@alexfoias
Copy link
Contributor

in this case the current setup should work, right ?

@jcohenadad
Copy link
Member Author

stable should not show "stable", but the latest version tag. @joshuacwnewton do you know if this is possible? is that what you've implemented in sct?

@alexfoias
Copy link
Contributor

alexfoias commented Nov 11, 2020

I found the info higher

As for the stable release (the fact that we want the actual number), it's a feature that has been requested but not merged yet.readthedocs/readthedocs.org#4529

@jcohenadad
Copy link
Member Author

I found the info higher

As for the stable release (the fact that we want the actual number), it's a feature that has been requested but not merged yet.readthedocs/readthedocs.org#4529

indeed, it was my misunderstanding. I'm OK with the current proposed change.

@alexfoias
Copy link
Contributor

We can close this comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation category: readthedocs or user doc
Projects
None yet
Development

No branches or pull requests

3 participants