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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c37b66f
simplify
NicolasHug Apr 25, 2021
c2a36f9
Merge branch 'master' into gallery_vers
NicolasHug Apr 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 •
edited
Loading

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

-e git+git://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
9 changes: 0 additions & 9 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,15 +281,6 @@ def inject_minigalleries(app, what, name, obj, options, lines):
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
"""

conf_file_path = Path(__file__).parent.absolute()
backrefs_path = conf_file_path / sphinx_gallery_conf['backreferences_dir'] / (name + '.examples')
if not (os.path.isfile(backrefs_path) and os.path.getsize(backrefs_path) > 0):
# We avoid showing the (empty) minigallery if there's nothing to show, i.e. if the object
# isn't used in any example.
# FIXME: this check can be removed once https://github.com/sphinx-gallery/sphinx-gallery/pull/813
# is merged and the new sphinx-gallery version (> 0.8.x) is released.
return

if what in ("class", "function"):
lines.append(f".. minigallery:: {name}")
lines.append(f" :add-heading: Examples using ``{name.split('.')[-1]}``:")
Expand Down