trio icon indicating copy to clipboard operation
trio copied to clipboard

Make sure trio works with Read the Docs Addons

Open A5rocks opened this issue 1 year ago • 2 comments

I saw https://about.readthedocs.com/blog/2024/07/addons-by-default/ and it looks like we might have to make some changes. Its not very clear to me what changes exactly though. And it seems the theme support for it is in a dev release so we should probably wait.

A5rocks avatar Aug 08 '24 01:08 A5rocks

Should wait for RTD theme's 3.0 release.

A5rocks avatar Aug 26 '24 05:08 A5rocks

Should wait for RTD theme's 3.0 release.

Note that this is already released: https://pypi.org/project/sphinx-rtd-theme/3.0.0/

humitos avatar Oct 08 '24 13:10 humitos

FYI @humitos (since I don't want to fill out a random "support" form just for feedback) I don't think it was made very clear what RTD injected into html_context. I just realized that the version we were showing wasn't quite right (because we used current_version) and I suspect this might be common for anyone who customized the layout of the RTD sphinx theme (which used that).

To show it isn't just me, I found that e.g. https://github.com/microsoft/torchgeo (anything depending on https://github.com/pytorch/pytorch_sphinx_theme and using RTD) has this issue too. It's nothing big (literally just a visual bug) but if there's some obvious way for RTD to notify project owners about past html_context that might be appreciated.

A5rocks avatar Mar 13 '25 04:03 A5rocks

don't think it was made very clear what RTD injected into html_context

Starting in the last October, Read the Docs injects nothing into html_context. Read https://about.readthedocs.com/blog/2024/07/addons-by-default/

In the same blog post, there is a Sphinx extension mentioned that can be used to recover most of the injections done by Read the Docs in the past.

humitos avatar Mar 17 '25 18:03 humitos

Yeah, I guess I didn't really think through the consequences of that as much as I should have. (Well, mostly just that I forgot how exactly our docs did things. I saw something about allcaps READTHEDOCS so used that and somehow missed the thing next to it...)

A5rocks avatar Mar 17 '25 20:03 A5rocks