Remote HTML announcement banner not working

[Supsa]

Hi
First of all, a huge thanks for PyData Theme!

I have trouble to display the announcement banner. I am using pydata-sphinx-theme 0.16.1 and I have followed the documentation here by including the following line in the html_theme_options in my conf.py :

"announcement": "https://gitlab.com/AlexandreCoche/geop4th/raw/doc/public/banners/banner.html"

However the announcement banner does not appear.

If I use a local HTML text, it works well. Also the version warning banner works fine too.

Am I missing a part?

Best,

[drammock]

that is surprising. Does it work if you set class="sidebar-message" on your div tag?

Looking at your site, the aside is getting created (note the highlighted-in-blue bit), but the content of your template file isn't getting added as its child:

[Supsa]

@drammock Thank you a lot for your quick reply! I have tested adding class="sidebar-message" and it does not solve the issue but I have identified the source of the problem: it seems that the content of the url I specified cannot be retrieved. I have tried replacing with:

"announcement": "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html"

and it works.

I did not realize that before because I only tested with the documentation example url "https://github.com/pydata/pydata-sphinx-theme/raw/main/docs/_templates/custom-template.html" (instead of its redirected url "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html") and I had the same problem as with my url.
(and as I understand there is no equivalent of https://raw.githubusercontent.com for Gitlab, and https://.../raw/... urls cannot be retrieved directly as raw. I do not know how PyData Theme retrieved the content but I have read here that curl requests against this kind of urls redirect.)

I suggest that the url example of the documentation could be replaced with https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html.

So the mistake was mine, sorry for that and thank you for your help!

[drammock]

interesting. You could try https://gitlab.com/AlexandreCoche/geop4th/-/raw/doc/public/banners/banner.html?inline=false (which is the link I get when trying to download your banner rather than view it). If that doesn't work, you can try using their API: https://docs.gitlab.com/api/repository_files/#get-file-from-repository; maybe something like (not tested):

https://gitlab.com/api/v4/projects/66646181/geop4th/files/doc/public/banners/banner.html?ref=doc (you may need to include an access token, not sure)

As for why it works for our docs, it's being done in JavaScript (not using curl) so behavior may be different. Nonetheless:

I suggest that the url example of the documentation could be replaced with https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html.

That seems sensible as it uses GitHub's preferred file access method. Could you open a pull request to make that change?

[Supsa]

Indeed, it worked! Than you very much for your help!
I had to move the .html file to the root of the repository but the following line works well now (without the need for an access token):

"announcement": "https://gitlab.com/api/v4/projects/66646181/repository/files/banner.html/raw?ref=doc"

Sure, I am going to open a pull request.

Best