sphinx-themes / sphinx-themes.org

A showcase for Sphinx documentation themes
https://sphinx-themes.org
BSD 2-Clause "Simplified" License
234 stars 44 forks source link

Run the build weekly, against the latest Sphinx version #70

Closed pradyunsg closed 3 years ago

pradyunsg commented 3 years ago

I just noticed that #69 was made and merged without reviews. Here's my attempt to solve the underlying issues in a better way.

shirou commented 3 years ago

But, hmm, it seems pydata-sphinx-theme has been updated 2 days ago and perhaps because of that update, 4.0.0b1 is failing.

pradyunsg commented 3 years ago

@choldgraf @jorisvandenbossche FYI: the latest pydata-sphinx-theme release is failing to build with the latest Sphinx release.

choldgraf commented 3 years ago

This is the failing line https://github.com/sphinx-themes/sphinx-themes.org/pull/70/checks?check_run_id=2377148747#step:8:152

jorisvandenbossche commented 3 years ago

Strange, I don't see a failure locally with our demo docs using sphinx 4.0.0 beta.

pradyunsg commented 3 years ago

Rebasing this on master, which has a trimmed list of themes now (#72); and also removed pydata-sphinx-theme from the list to unblock this.

We should implement something to prevent broken themes from breaking the build process in the future.

choldgraf commented 3 years ago

Does this mean that we need to remember to add the pydata theme to this page's preview in the future?

And more generally - it sounds like this PR is implicitly implementing a policy for this repository that any theme that doesn't build on the next pre-release of Sphinx is removed from the website. Is that true? If so we should document this.

pradyunsg commented 3 years ago

As a broader policy, I do think this site will be building against the latest Sphinx release (including the latest pre-release) that the theme's latest release claims to be compatible with. I'll document that in a follow up PR sometime next week.

I'll also be adding the pydata-sphinx-theme back, once a release containing a fix happens or I come around to resolving the whole the entire-build-fails-because-one-theme-failed behaviour -- whichever is first. I don't want to be removing-readding themes constantly though, especially with a weekly build cycle, but that can't change until we have more graceful handling of failures here.

choldgraf commented 3 years ago

Sounds good, I agree w/ all of that :-) I just wanted to make sure we were on the same page!

jorisvandenbossche commented 3 years ago

BTW I released pydata-sphinx-theme so it should no longer fail with latest sphinx/jinja2