Skip to content
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

stop vendoring sphinx-gallery #9189

Closed
amueller opened this issue Jun 20, 2017 · 3 comments
Closed

stop vendoring sphinx-gallery #9189

amueller opened this issue Jun 20, 2017 · 3 comments

Comments

@amueller
Copy link
Member

amueller commented Jun 20, 2017

I really think we should not vendor sphinx-gallery. It created a whole host of problems for trying to do the 0.18.2 release. I don't really see a benefit in vendoring it, given that we can always pin the version in the CI.

We could even require a particular version in our conf.py, but the version of sphinxgallery you need is much more dependent on the version of sphinx then the version of scikit-learn.
Since we don't vendor sphinx (and we really shouldn't), vendoring sphinxgallery will break things.

@jmschrei
Copy link
Member

What does vendoring it mean? Is this only used if you want to build the documentation locally?

@glemaitre
Copy link
Member

What does vendoring it mean? Is this only used if you want to build the documentation locally?

scikit-learn doc is configured to use the bundled sphinx-gallery -> https://github.com/scikit-learn/scikit-learn/tree/master/doc/sphinxext

The same way we do it with joblib.

@amueller
Copy link
Member Author

sphinx will break sphinx-gallery again in the next sphinx release, see sphinx-gallery/sphinx-gallery#270, which means at the next release of sphinx, 0.19 docs will not build any more if we decide to vendor again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
scikit-learn 0.19
Awaiting triage
Development

No branches or pull requests

3 participants