Skip to content

docs: redirect default ReadTheDocs root to stable version#1709

Closed
Amitjoiya wants to merge 3 commits intosbi-dev:mainfrom
Amitjoiya:Amitjoiya/1708
Closed

docs: redirect default ReadTheDocs root to stable version#1709
Amitjoiya wants to merge 3 commits intosbi-dev:mainfrom
Amitjoiya:Amitjoiya/1708

Conversation

@Amitjoiya
Copy link

Summary

This PR updates the ReadTheDocs configuration so that the default
documentation (https://sbi.readthedocs.io/en/) redirects to the stable
version rather than latest, as requested in issue #1708.

Changes

  • Added a redirects rule to .readthedocs.yml to point //en/stable/.

No other files were modified.

@janfb
Copy link
Contributor

janfb commented Nov 20, 2025

Thanks for addressing this @Amitjoiya !

The redirect is certainly one solution. but could you please check whether there is a setting in the Readthedocs settings to just have the stable version as the default site?

@codecov
Copy link

codecov bot commented Nov 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@f3222f9). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1709   +/-   ##
=======================================
  Coverage        ?   84.65%           
=======================================
  Files           ?      137           
  Lines           ?    11487           
  Branches        ?        0           
=======================================
  Hits            ?     9724           
  Misses          ?     1763           
  Partials        ?        0           
Flag Coverage Δ
unittests 84.65% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

@Amitjoiya
Copy link
Author

Amitjoiya commented Nov 20, 2025

Hi @janfb ,
I checked the ReadTheDocs dashboard on my fork, but it only shows latest in the “Default version” dropdown — the stable version isn’t available there.
This makes sense because RTD only builds stable for the main project, not for forks.

So the “Default version → stable” change can only be applied on the official SBI ReadTheDocs project, where the stable build exists.

My PR adds the redirect as a fallback, but the actual fix requires switching:
RTD Project → Advanced Settings → Default version → stable
on the main project.

Happy to update/remove the redirect depending on what you prefer.

@janfb
Copy link
Contributor

janfb commented Nov 20, 2025

yes, that's much better, please go ahead with this solution.

@Amitjoiya
Copy link
Author

Amitjoiya commented Nov 20, 2025

@janfb , Good morning!
Thanks for the clarification. I’ve updated the .readthedocs.yaml file exactly as advised and ensured there are no formatting or whitespace issues left.
Pre-commit is clean now and the redirect is working correctly for / → /en/stable/.

If there’s anything else that needs refinement, I’d be happy to adjust it.
Thanks again for guiding me — learning a lot from this!

@janfb
Copy link
Contributor

janfb commented Nov 21, 2025

Thanks for the changes and looking further into this.

It seems we were too slow here and there was a settings-based solution that @michaeldeistler found and applied just now.

Sorry about that, @Amitjoiya - Your initiative here is nevertheless much appreciated!

You are welcome to have a look at another issue. Please comment below the issue you are interested in to first discuss how to solve it, before opening a PR - Thank you!

@janfb janfb closed this Nov 21, 2025
@Amitjoiya Amitjoiya deleted the Amitjoiya/1708 branch November 21, 2025 15:48
@Amitjoiya Amitjoiya restored the Amitjoiya/1708 branch November 21, 2025 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants