Skip to content

[MRG] Use sphinx-gallery 0.3.1 in doc build#14507

Merged
glemaitre merged 1 commit intoscikit-learn:masterfrom
lesteve:use-latest-sphinx-gallery-release
Jul 31, 2019
Merged

[MRG] Use sphinx-gallery 0.3.1 in doc build#14507
glemaitre merged 1 commit intoscikit-learn:masterfrom
lesteve:use-latest-sphinx-gallery-release

Conversation

@lesteve
Copy link
Copy Markdown
Member

@lesteve lesteve commented Jul 29, 2019

I don't really understand why sphinx-gallery version was restricted in #13422 (comment). I can build locally with sphinx-gallery 0.4 without problem.

Of course if anyone remembers why this was done, comments and objections more than welcome!

Once the doc is built I'll have a look at a few pages and check that the output is similar on the dev doc and on this PR doc.

@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Jul 29, 2019

Looks like scikit-image=0.12.3 is not on conda anymore. (conda search scikit-image)

@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 29, 2019

Yeah I saw that @amueller asked on the conda gitter channel. Apparently this is due to https://www.anaconda.com/why-we-removed-the-free-channel-in-conda-4-7.

@lesteve lesteve mentioned this pull request Jul 30, 2019
Closed
@rth rth mentioned this pull request Jul 30, 2019
Merged
@lesteve lesteve force-pushed the use-latest-sphinx-gallery-release branch from 422b120 to 9f539c4 Compare July 30, 2019 14:16
glemaitre
glemaitre approved these changes Jul 30, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. It seems that the PyPi release was broken for 0.3.0 for some reason.
Merging it turns green.

@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 30, 2019 •
edited
Loading

Full disclosure: I saw at least one difference that was not expected. The print(__doc__) create empty output boxes (the yellowish box in the snapshot below):

image

Whether that is enough to prevent this PR being merged I don't know. This is probably reasonably easy to fix in sphinx-gallery.

The doc page the snapshot is coming from:
dev

this PR (from a previous build that I expect to be identical)

An alternative would be to install sphinx-gallery==0.3.1 since the sphinx-gallery output is sphinx-gallery/sphinx-gallery@40d7e65 which is in 0.4.0.

@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Jul 30, 2019

Uhm, yep this is a bit problematic, IMO. When is the next sphinx-gallery release ;)

@lesteve lesteve force-pushed the use-latest-sphinx-gallery-release branch from 9f539c4 to b560966 Compare July 31, 2019 05:42
@lesteve lesteve force-pushed the use-latest-sphinx-gallery-release branch from b560966 to 345d8ab Compare July 31, 2019 05:44
@lesteve lesteve changed the title [MRG] Use latest sphinx-gallery in doc build [MRG] Use sphinx-gallery 0.3.1 in doc build Jul 31, 2019
@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 31, 2019

I pushed a commit using sphinx-gallery 0.3.1. I suspect this will get rid of the output boxes but I'll double-check.

@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 31, 2019 •
edited
Loading

Yep the yellowish output boxes have gone with sphinx-gallery 0.3.1:
https://67413-843222-gh.circle-artifacts.com/0/doc/auto_examples/decomposition/plot_kernel_pca.html#sphx-glr-auto-examples-decomposition-plot-kernel-pca-py

this PR doc
dev doc

@glemaitre glemaitre merged commit e0f0b3d into scikit-learn:master Jul 31, 2019
@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Jul 31, 2019

Thanks @lesteve

@lesteve lesteve deleted the use-latest-sphinx-gallery-release branch July 31, 2019 08:34
@lesteve lesteve mentioned this pull request Aug 7, 2019
Closed
@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Aug 9, 2019

Once sphinx-gallery/sphinx-gallery#529 gets released we can use the latest sphinx-gallery? :)

lesteve added a commit to lesteve/scikit-learn that referenced this pull request Aug 28, 2019
@lesteve
CI/DOC Use sphinx-gallery 0.3.1 (scikit-learn#14507)
06a9e9b
lesteve added a commit to lesteve/scikit-learn that referenced this pull request Aug 28, 2019
@lesteve
CI/DOC Use sphinx-gallery 0.3.1 (scikit-learn#14507)
fb34317
lesteve added a commit to lesteve/scikit-learn that referenced this pull request Aug 28, 2019
@lesteve
CI/DOC Use sphinx-gallery 0.3.1 (scikit-learn#14507)
4c9afa0 
[doc build]
@lesteve lesteve mentioned this pull request Aug 28, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@glemaitre glemaitre glemaitre approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lesteve @thomasjpfan @glemaitre