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

Build release specific RTD docs, link to current release when not deploying dev branch #2076

Open
mikkonie opened this issue Feb 21, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation environment Issues of dependencies, CI, deployment etc.

Comments

@mikkonie
Copy link
Contributor

mikkonie commented Feb 21, 2025

Currently, the logic to link out to RTD in SODAR is as follows:

  • If we are running SODAR on a development commit, link to dev
  • Else, link to latest

However, this may not always be what we want. I can think of multiple cases where this may fail, some already seen in real life:

  • If an instance stays at an older release version, purposefully or otherwise, users are directed to documentation for a newer release which may be vastly incompatible
  • Tagging a release when deploying an older non-dev commit creates the same situation

This should be fixed as follows:

  • Build docs by version number for each release
  • If on a release commit, link to docs for that release
  • Else, link to dev like we do now

We used to build release-specific docs but it seems we don't do that anymore? Maybe I've messed something up in the RTD configuration.

@mikkonie mikkonie added documentation Improvements or additions to documentation environment Issues of dependencies, CI, deployment etc. labels Feb 21, 2025
@mikkonie mikkonie self-assigned this Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation environment Issues of dependencies, CI, deployment etc.
Projects
None yet
Development

No branches or pull requests

1 participant