-
Notifications
You must be signed in to change notification settings - Fork 793
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
Add altair sphinx extension back to package? #3051
Comments
We also use this, love altair, and would rather not copy |
Move of I think the main goal of that PR was to get the tests out of the altair module into a separate folder and How about we only move the |
Thanks, that would be great. And if you really don't want it included with the rest of altair, it could be a separate package |
Yes, that would be great! |
I'll wait for @mattijn's input before working on this. |
I was unaware that there were other packages depending on the I've seen repositories struggling how to make these Altair plots appear in documentation. If it is a separate package I think it will make it easier to discover, install and use in other projects. For the short-term, we can move it back as @binste described including and add a deprecation warning and setup a separate |
Using GH Search I can find only 5 actively maintained repositories which rely on
I could move the |
I'm in favor of moving it directly into a separate package like you suggested. |
Agreed. We also use it in projects on GitLab, but people who have been using |
@binste, I created https://github.com/altair-viz/sphinxext-altair. I think that should be sufficient to make a start with the transition? |
Published https://github.com/altair-viz/sphinxext-altair on pypi. You can install it with extensions = [
...
"sphinxext_altair.altairplot",
...
] This should give you the same functionality as before. Let me know how it goes! I also added a note to the release on github and will do the same for the docs. |
Very cool, thank you! Is it okay if I turn this into a conda package (i.e. I would open a PR at https://github.com/conda-forge/staged-recipes)? |
I've never created a conda package so this would be great, thank you! |
PR is here: conda-forge/staged-recipes#22811 Update: available on conda-forge now, see https://anaconda.org/conda-forge/sphinxext-altair |
Thank you @binste and @mattijn for creating https://github.com/altair-viz/sphinxext-altair/ so quickly! This resolves the issue for me 🥳 |
With version 5.0.0 (thank you for the release! 🥳) the altair sphinx extension was removed from the package. It used to be importable from
altair.sphinxext
. Would it be possible to bring that back?There is a small number of projects on GitHub that use the extension in their own code base: https://github.com/search?q=%22altair.sphinxext%22&type=code including one of ours.
Thank you!
The text was updated successfully, but these errors were encountered: