executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
431 stars 197 forks source link

Release v1.0.0 when we drop JQuery and add Bootstrap 5 #670

Open choldgraf opened 1 year ago

choldgraf commented 1 year ago

Context

Thus far we've been bumping minor versions "as if" they were major versions. However, this isn't necessary as there is nothing inherently "special" about a 1.0 release. We are also sort-of locked into an anti-pattern where we have no explicit criteria for when to "start treating major versions as breaking and follow a normal semver minor/patch process".

Proposal

So I propose that whenever we drop JQuery and upgrade to Bootstrap 5 via the latest pydata Sphinx theme, we do these things:

Tasks

consideRatio commented 1 year ago

Nice, it sounds perfectly fine to hold off for a shorter well defined time! Extra 👍 since you have already started the work.

Super happy about 1.0.0 in one more project, i think its a big win for maintainers and users.

pradyunsg commented 1 year ago

Yes please! :)