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

Block sphinx versions for which links from search engine are broken #4910

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sciunto
Copy link
Member

@sciunto sciunto commented Aug 12, 2020

Description

Attempt to close #4647

-> need to check that the search engine is working for sphinx>=3.1.0

3.0.x

links are broken

3.1.0

Failure due to sphinx-doc/sphinx#7802

>=3.1.1

not checked yet

3.2.0

On my computer, with sphinx==3.2.0 (4 days ago), I have

Sphinx parallel build error:
KeyError: 'Shiboken'

But build is successful on circle-ci... however, the links are still broken.

@sciunto sciunto added the 🔧 type: Maintenance Refactoring and maintenance of internals label Aug 12, 2020
@sciunto sciunto changed the title Blacklist sphinx version for which search is broken Blacklist sphinx version for which links from search engine are broken Aug 12, 2020
@sciunto
Copy link
Member Author

sciunto commented Aug 12, 2020

@emmanuelle Would you like to try to reproduce the build failure I have with sphinx==3.2.0 please? We need to report if it can be reproduced.

@grlee77 grlee77 changed the title Blacklist sphinx version for which links from search engine are broken Black sphinx versions for which links from search engine are broken Aug 15, 2020
@grlee77 grlee77 changed the title Black sphinx versions for which links from search engine are broken Block sphinx versions for which links from search engine are broken Aug 15, 2020
@grlee77
Copy link
Contributor

grlee77 commented Aug 15, 2020

I'm sure no insensitivity was intended in this case, but I modified the PR title to be in line with the recommendations made in a recent discussion at SciPy: scipy/scipy#12446 (comment).

@sciunto
Copy link
Member Author

sciunto commented Aug 16, 2020

thanks @grlee77 I remember I read a blogpost along this line for like master/slave. I think I would have the reflex easily in my mother tongue, in english it might take longer, but I'll make the effort. Thanks for raising this again.

@sciunto sciunto marked this pull request as draft August 16, 2020 09:53
@emmanuelle
Copy link
Member

@sciunto I tested locally both with sphinx 3.2.0 and sphinx 3.2.1. I could not reproduce the build problem and the search was working correctly. Did you try in a fresh environment?

Also I'm not sure why you mention the links are broken on CI?

@emmanuelle
Copy link
Member

I think we can give it a try with 3.2.1

@sciunto
Copy link
Member Author

sciunto commented Aug 18, 2020

@emmanuelle Here is what I meant: click on one of the links from this query: https://216-2014929-gh.circle-artifacts.com/0/doc/build/html/search.html?q=threshold&check_keywords=yes&area=default

You will obtain "Artifact not found".

@emmanuelle
Copy link
Member

ok I understand. So yes, the new versions still have the problem :-(.

sphinx-gallery>=0.7.0
numpydoc>=1.0
sphinx>=1.8,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3,!=3.0.4
numpydoc>=0.9
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason for these changes here?

Copy link
Member

Choose a reason for hiding this comment

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

numpydoc and sphinx-gallery that is

Copy link
Member Author

Choose a reason for hiding this comment

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

No, I screwed up my rebase.

Copy link
Member

Choose a reason for hiding this comment

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

yea.... that is always annoying.

Copy link
Member Author

Choose a reason for hiding this comment

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

My goal over here is to build the doc with the last sphinx version, and if it appears to have broken links, to open a ticket upstream. I have no clue on this issue.

@hmaarrfk
Copy link
Member

is this ready now?

@sciunto
Copy link
Member Author

sciunto commented Aug 30, 2020

Base automatically changed from master to main February 18, 2021 18:23
@grlee77 grlee77 added the 🤖 type: Infrastructure CI, packaging, tools and automation label Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 type: Infrastructure CI, packaging, tools and automation 🔧 type: Maintenance Refactoring and maintenance of internals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update blocked versions for sphinx in requirement.txt
4 participants