-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Deprecate those kwargs in v3
that will break in v4
#5226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecate those kwargs in v3
that will break in v4
#5226
Conversation
The sphinx issues look like indentation errors, could you share the output of |
Full output with all the line breaks..
|
Looks like a pre-commit script is messing with the environment YAML files in ways that break their syntax. |
Might be the same pre-commit issue as in #5057? |
Thanks for the pointer! Looks like the docs theme on |
yeah these don't look that good, actually every sphinx theme renders these sections differently, @OriolAbril can we customize the v3 theme to make the deprecation warnings more prominent or similar to the latest version |
It was stopping to use our own script and using madforhooks one, all important changes were in the pre-commit yaml, but were multipe lines, in addition, after the change there are scripts not used anymore that can be removed but keeping them won't break anything.
We can try adding https://github.com/pydata/pydata-sphinx-theme/blob/master/src/pydata_sphinx_theme/assets/styles/_admonitions.scss or a subset of it to https://github.com/pymc-devs/pymc/blob/v3/docs/source/_static/main.css see if it works. I did not know about that at the time but this is yet another pro to add to the list of reasons to not use the old v3 custom sphinx theme. |
5eabadc
to
6e2c856
Compare
Except the check against print statements.
6e2c856
to
ad46508
Compare
For more automation in kwarg deprecations.
ad46508
to
9e1a553
Compare
@OriolAbril I fixed the pre-commit and CI. Please take a look :) @mjhajharia any news on the PR to |
nope no updates, i think we can go ahead with this now, i'm pretty available now so if there's more bugs let me know and i'll fix them and i'm making tests soon as well |
@OriolAbril try adding this content, I think that would work https://github.com/pydata/pydata-sphinx-theme/blob/102f741ae7568f3cbea28eae496169120c33c5ff/src/pydata_sphinx_theme/assets/styles/_admonitions.scss |
This is what I did originally, but scss and css seem to be quite different things, and adding that code in our main.css did not work, only the inital lines were taken into account. I don't know how to add scss directly to sphinx either, only css and js. I have now tried copying from the css via the html style inspector in mozilla, if it works great, if it doesn't I'll leave the admonition ugly, we can make a follow up PR if someone is interested |
With css taken from pydata-sphinx-theme.
642d25e
to
7efe08d
Compare
@OriolAbril I just squashed your commits. Looks like that invalidated your approval.. |
this looks very nice, thanks @OriolAbril and @michaelosthege!! |
The deprecation warnings are working, but the Sphinx build is not.
Also, @mjhajharia please reconsider if you want to contribute your changes back to the original project. They have a tickets about this feature (5 7 and 8 in https://github.com/tantale/deprecated/issues) already.
Also the original
deprecated
project is getting >2 million downloads per week, so it would be a more sustainable dependency.