search

sphinx-doc / alabaster

Lightweight, configurable Sphinx theme
http://alabaster.readthedocs.io/
Other
734 stars 186 forks source link

Remove Gratipay integration - gratipay has shut down #128

Closed joealcorn closed 6 years ago

joealcorn commented 6 years ago

Gratipay shut down at the end of 2017. It's a shame because open source sustainability is an important topic. Perhaps instead of removing donate.html, we could extend it to support patreon and open collective? (are there other services?)

bitprophet commented 6 years ago

Weird, I thought this already got nixed but I must be misremembering or recalling their old name-change from Gittip. Thanks for the input!

I like the idea of changing it to something else instead of straight removal, especially since the template name and some of the language is sufficiently generic. May leave this open until I or others have time to really scan the horizon for what's best.

Tho...probably just want to make the setting names & everything else extra-generic so users can plug in whatever they want? May require expecting users to modify their own template, since these sorts of buttons are usually custom HTML tags (like the Gratipay one was.)

bitprophet commented 6 years ago

Consensus at sprints today is that we should just move ahead with merging this and worry about re-adding a generic donation.html later.

My main question now (and one that has been long-standing and long-avoided) is how to release this sort of VERY breaking change while ALSO distributing non-breaking changes. We're pinned at >0.7,<0.8 in Sphinx's setup.py, so I've been just incrementing the bugfix number, but that won't fly for this. So we should just pop out a 1.0 probably, have Sphinx eventually require that version (or just be looser, which may be better...I no longer recall why we wanted to tighten it so much) and try to iterate more normally.

bitprophet commented 6 years ago

I'll think about this some more and poke around, hopefully we'll figure something out by end of sprints. May go bother any Sphinx people who are here at PyCon to get their opinion.

bitprophet commented 6 years ago

Doesn't seem like Sphinx is sprinting this year but I might still put out a call to see if principals happen to be here anyway.

That said I triple checked my old commit that pinned us, and thanks to my habit of detailed commit messages, I can confirm the main point was to prevent a loose pin from meaning users incidentally upgraded past incompatible versions: https://github.com/sphinx-doc/sphinx/pull/1759

So I think what this means is:

joealcorn commented 6 years ago

how to release this sort of VERY breaking change

It's breaking in the sense that the functionality no longer exists, but having those options in your config shouldn't break the build (as far as I'm aware?) so is it really "breaking"?

bitprophet commented 6 years ago

@joealcorn Sadly, it is breaking, I was not happy to discover that. I tested what a user who's currently setting gratipay_user = 'foo' would experience with the PR merged, and Sphinx goes kaboom, because setting an option which the theme doesn't account for, is considered an error.

Similarly, a user referencing donation.html in their sidebar config will encounter an error when that file is removed.

So at that point we're really facing down just jumping straight to #132, though even if a nice generic patch for that appeared today we'd need to make sure it still didn't look fugly for anyone who previously had the gratipay version. (And we'd still have to keep the gratipay and gittip user options around, etc. Gotta rip that bandaid off sometime...)

bitprophet commented 6 years ago

Returning to this while handling #142, #143 - I don't have the bandwidth to handle the planned jump to 1.0 right now, and since we'd probably have wanted to do some version of this anyways, I think I'm just gonna: