search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.43k stars 2.1k forks source link

4.0.0 release plan #9056

Closed tk0miya closed 3 years ago

tk0miya commented 3 years ago

According to our annual release cycle, this April is time for the major release. I think this schedule is good for the release. What do you think?

Any comments?

Note: issues marked as 4.0.0: https://github.com/sphinx-doc/sphinx/milestone/74

ericholscher commented 3 years ago

If we can confirm that Sphinx and alabaster are working well with 0.17, I'd be 👍 on pinning to docutils<0.18. We can add alabaster to the work in #9088, and confirm it there prior to release.

tk0miya commented 3 years ago

I'm perfectly confused by the pinning of docutils. So I stopped releasing for a while. refs: #9088

astrojuanlu commented 3 years ago

@tk0miya sorry it took us a few days to finally get to this. @humitos and I have just validated that Sphinx with alabaster looks good with Sphinx 4.0 beta and docutils 0.17.

The only noticeable visual difference I observed, after comparing both versions side to side, are in emphasized code lines (baseline, test).

I get the impression that alabaster is not maintained anymore (last commit is from January 2020 and says "Last ever LICENSE copyright update"), therefore I don't think it's worth trying to make a new release of alabaster fixing this small visual difference.

In conclusion: in line with the conditions we agreed here and in #9088, my understanding is that Sphinx 4.0 can pin docutils<0.18, and allow 0.17.

tk0miya commented 3 years ago

Now I just released the 4.0.0b2 package. And I posted announce to sphinx-users, sphinx-dev and python-announce-list. https://pypi.org/project/Sphinx/4.0.0b2/

I'll wait for reactions from users in a week. So the final release will be shipped on 8th May.

Thank you for your support all :-)

pradyunsg commented 3 years ago

Thanks @tk0miya and I'm glad you are feeling better! ^.^

tk0miya commented 3 years ago

The only noticeable visual difference I observed, after comparing both versions side to side, are in emphasized code lines (baseline, test).

I think it's not related to the themes. It comes from a change in #7942.

ericholscher commented 3 years ago

@tk0miya I think we're good to release 4.0 on 8th May 🎉 Thanks for working with us here to minimize impacts for users, and @astrojuanlu, @humitos, @pradyunsg, and others for jumping in to help test things.

Hopefully we can make this process smoother in the future by thinking more about how to pin dependencies (#9091), and building on the work we've done here to test releases of major dependencies (#9088). I'm excited about the collaboration here, and hope we can build on it for future releases.

tk0miya commented 3 years ago

It seems no issues are reported since beta2. So I'll do releasing in tomorrow at noon in JST (about 10-12hrs later).

tk0miya commented 3 years ago

From now on, I start releasing!

tk0miya commented 3 years ago

Done. Thank you for all!