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

Use sphinx-galery 0.9 and simplify conf.py #3724

Merged
merged 2 commits into from
Apr 26, 2021

Conversation

NicolasHug
Copy link
Member

Now that sphinx-gallery 0.9 is released, we can simplify the logic of inject_minigalleries().

@@ -1,5 +1,5 @@
sphinx==2.4.4
sphinx-gallery
sphinx-gallery>=0.9.0
matplotlib
numpy
Copy link
Contributor

@oke-aditya oke-aditya Apr 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we can avoid numpy dependency. matplotlib covers it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, but it doesn't hurt to be explicit for those things IMHO.
Who knows: we might end up not using matplotlib for showing images, or mpl may even not depend on numpy at some point (quite unlikely I agree)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the best practice is to we avoid transitive dependencies and define explicitly. With a quick look on the documentation folder, I don't see a direct import on numpy (only some references on the config) but if it is a necessary dependency I would leave it explicitly defined for the reasons that Nicolas explained.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have an explicit dep on numpy in gallery/plot_transforms.py which isn't in the doc folder, but it's still part of the doc building

Copy link
Contributor

@datumbox datumbox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@NicolasHug NicolasHug merged commit 08fa7d6 into pytorch:master Apr 26, 2021
@NicolasHug NicolasHug deleted the gallery_vers branch April 26, 2021 08:47
facebook-github-bot pushed a commit that referenced this pull request May 4, 2021
Reviewed By: NicolasHug

Differential Revision: D28169119

fbshipit-source-id: 7788887d3dcfad87bfeeaccfb5f49d068b209395
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants