search

jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
177 stars 28 forks source link

update for pydantic v2 #269

Closed 2bndy5 closed 1 year ago

2bndy5 commented 1 year ago

resolves #268

Also improves the color specification for custom admonitions by using the new pydantic-extra-types pkg. This means that the admonition color can be defined using a value compliant with CSS3 specs. Color transparency is ignored since all admonitions' colors use the same transparency (where applicable).

Pinned pydantic dependency to v2.0+ due to backward-incompatible changes (and better performance).

2bndy5 commented 1 year ago

I completely agree! The migration guide does offer some rationality about the changes, however most of the rationale seems implementation-specific or focused on edge-cases.

I still feel a bit sore that they pushed the v2 release without revising/adding the docs for many of the changes. But I seem abnormally adamant about doc composition... 😉

Optimistically, I'm happy about the newly available Color validation type.

2bndy5 commented 1 year ago

Pushing a patch bump to prevent any users from hitting the same crash that v2 is causing.

vsoch commented 12 months ago

Does this issue resolve this bug? https://github.com/sphinx-doc/sphinx/issues/11479 If not I can open a new issue!

2bndy5 commented 12 months ago

Yes, I pushed v0.11.5 pretty quickly to quell the problem in #268 (which is the same problem reported in sphinx-doc/sphinx#11479).

Please pin you doc dependencies to

sphinx-immaterial>=0.11.5
vsoch commented 12 months ago

Awesome, thank you!