Release 0.16.0 - Githubissues

Carreau commented 2 months ago

I think with the recent sphinx 8 fixes it woudl be good to make a new release potentially dropping older shinx. Here are the list of things to do for a new release.

Double check for quality-control

[x] There are no open issues with a impact: block-release label

Prepare the codebase for a new version

[x] Bump __version__ in __init__.py
[x] Update our version switcher .json file with the new version
[x] Make a release commit: git commit -m 'bump: 0.1.9 → 0.2.0'
[x] Push the RLS commit git push upstream main
[x] If a release candidate is needed, tick this box when we're now ready for a full release.

Make the release

[x] Start a new GitHub release
- Call the release the current version, e.g. v0.2.0
- In the Choose a Tag: dropdown, type in the release name (e.g., v0.2.0) and click "Create new tag"
- In the Target: dropdown, pin it to the release commit that you've just pushed.
- Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made)
[x] Confirm that the release completed
- The publish github action job has completed successfully in the actions tab.
- The PyPI version is updated
[x] Hide the previous patch version build in the RDT interface if needed.
[x] Celebrate, you're done!

[^release-refs]: Taken from the release checklist. See the release documentation for an overview of release processes.

Elodie-Praxinos commented 2 months ago

Just to say I'd really like a version compatible with Sphinx 8 too!

Carreau commented 2 months ago

I don't think it's incompatible, did you encounter any specific errors ?

Elodie-Praxinos commented 2 months ago

Yes:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. myst-parser 0.17.0 requires docutils<0.18,>=0.15, but you have docutils 0.21.2 which is incompatible. myst-parser 0.17.0 requires sphinx<5,>=3.1, but you have sphinx 8.0.2 which is incompatible.

drammock commented 2 months ago

Please try updating myst parser. Current stable release is 4.0.0 and you seem to have 0.17.0

Elodie-Praxinos commented 2 months ago

Indeed, that helped. Now I got other issues probably coming from the fact I am already using a different theme (sphinx-material).

pickling environment... WARNING: cannot cache unpickable configuration value: 'html_context' (because it contains a function, class, or module object) [config.cache]
done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... done
copying extra files... done
copying assets: done
writing output... [  1%] 
Extension error (pydata_sphinx_theme):
Handler <function update_and_remove_templates at 0x1131fce50> for event 'html-page-context' threw an exception (exception: 'logo-text.html' not found in ['/Users/elodie/Documents/github/Doc/source/_templates', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/pydata_sphinx_theme/theme/pydata_sphinx_theme/components', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/pydata_sphinx_theme/theme/pydata_sphinx_theme', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/sphinx/themes/basic'])

dylanh724 commented 1 month ago

dopplershift commented 1 month ago

MetPy's docs are building fine with sphinx 8.0.2 and pydata-sphinx-theme 0.15.4 (myst-parser 4.0.0).

dbitouze commented 1 month ago

MetPy's docs are building fine with sphinx 8.0.2 and pydata-sphinx-theme 0.15.4 (myst-parser 4.0.0).

The same applies to the French LaTeX FAQ :blush:

drammock commented 1 month ago

@trallard @Carreau seems like we're close to being ready for another release? Only listed blockers are #1982 (which looks to be basically done?) and #1938 (which I think can be closed as completed given the comments above). #1992 made me realize some nice improvements still aren't in the hands of stable users.

trallard commented 1 month ago

We should be able to make a release whenever (https://github.com/pydata/pydata-sphinx-theme/pull/1982 is now merged), and we have been testing against Sphinx 8, and I have not spotted anything amiss. Neither of our CIs has so it is up to you @drammock, shall we cut a pre-release?

drammock commented 1 month ago

shall we cut a pre-release?

Yes I think so. I probably can't do it until next Wednesday so if one of you has time sooner then go for it

trallard commented 1 month ago

I shall be able to do this on Monday.

trallard commented 3 weeks ago

The pre-release is now out https://pypi.org/project/pydata-sphinx-theme/0.16.0rc0/ This can be installed with pip install pydata-sphinx-theme==0.16.0rc0 --pre

There is also a discussion opened https://github.com/pydata/pydata-sphinx-theme/discussions/1997

trallard commented 1 week ago

There do not seem to be any major issues identified through the release candidate, and the few bugs raised have been addressed. So will target to make a full release early this week 🚀

dbitouze commented 1 week ago

@12rambau and @Carreau There's still time to adjust the French translation (#2010), isn't it?

melissawm commented 1 week ago

When building the NumPy docs I noticed an issue with the search navbar-item:

Captura de imagem_20241014_151241

I am not sure if that comes from the theme or one of our customizations but will check.

SciPy looks good as far as I can tell 👍🏻

drammock commented 1 week ago

@trallard what about #2007 ? It's minor enough that I didn't label as a release blocker, but by the same token it's minor enough that I'd be comfortable rolling it in as a bugfix between RC and release (if you or @gabalafou look and don't notice anything amiss, that is)

dbitouze commented 1 week ago

@melissawm

When building the NumPy docs I noticed an issue with the search navbar-item:

Already reported and fixed :wink:

trallard commented 1 week ago

@drammock, I think it is okay to include #2007. It is a bug (I just checked the Figma file, and the hover colour change went missing somehow), but it is small enough that I do not expect it to cause any issues. I did leave a comment on the tests, though.

@dbitouze I can definitely get the translations in.

dbitouze commented 1 week ago

@dbitouze I can definitely get the translations in.

Sorry, I don't see what you mean.

trallard commented 1 week ago

Sorry if I was not clear enough @dbitouze. I meant that if the French translations are updated I should be able to include them in the proper release.

trallard commented 5 days ago

🎉 🚀 I just cut a new release so will go ahead and close this issue 👉🏽 https://pypi.org/project/pydata-sphinx-theme/0.16.0/

pydata / pydata-sphinx-theme

Release 0.16.0 #1948