url field is defined but not invoked

[ragonneau]

Hi!

My project

I am building a project using pydata-sphinx-theme, for which I set up a version switch as follows:

• Python configuration: https://github.com/ragonneau/cobyqa/blob/main/docs/source/conf.py#L83-L88,
• JSON source: https://github.com/ragonneau/cobyqa/blob/main/docs/source/_static/switcher.json.

The result can be seen here.

My problem

The switcher is on its own working, but the url field defined in switcher.json is not invoked, and switcher['url_template'] is used instead.

Thank you in advance for your help,
Tom.

[tupui]

Hi @ragonneau, thanks for reporting. This is because this feature is not yet deployed. The current website is wrongly showing the current state of the code instead of the release. It should be fixed in #574

cc @jorisvandenbossche

[ragonneau]

Hi @tupui and @jorisvandenbossche, I understand! I will leave my code as-is and update the theme version whenever the current state is released.

Thank you very much,
Tom.

[damianavila]

@jorisvandenbossche @choldgraf

The current website is wrongly showing the current state of the code instead of the release.

This is showcasing that we may want to show stable instead of latest as the default entry point for RTD, WDYT?

[choldgraf]

My personal preference is to just make releases more often so that the docs don't go out-of-sync with the main branch, but if folks prefer having two different documentation sites, that works as well. Do you have strong opinions?

[tupui]

My personal preference is to just make releases more often so that the docs don't go out-of-sync with the main branch, but if folks prefer having two different documentation sites, that works as well. Do you have strong opinions?

Only drawback with this is that you will rapidly have a huge version listing no? I do like the continuous-like deployment part!

[damianavila]

After some discussion about this one, we are not pointing RTD default to stable to prevent this sort of mismatch between the released package and the docs. Closing this one now.

[tupui]

For anyone else, there might be some caching preventing to see that the website was updated.