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

The documentation cannot be built with Sphinx 3 #4475

Closed
Gallaecio opened this issue Apr 6, 2020 · 5 comments · Fixed by #4480
Closed

The documentation cannot be built with Sphinx 3 #4475

Gallaecio opened this issue Apr 6, 2020 · 5 comments · Fixed by #4480

Comments

@Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented Apr 6, 2020

No description provided.

@anusha94
Copy link

@anusha94 anusha94 commented Apr 6, 2020

can I take this up?

@elacuesta
Copy link
Member

@elacuesta elacuesta commented Apr 6, 2020

Seems like this is an issue in the sphinx-hoverxref extension: readthedocs/sphinx-hoverxref#45.
If we can't wait for the upcoming release as mentioned in readthedocs/sphinx-hoverxref#45 (comment), we might want to try temporarily disabling it in our configuration.

@Gallaecio Gallaecio added this to the v2.1 milestone Apr 9, 2020
@Gallaecio
Copy link
Member Author

@Gallaecio Gallaecio commented Apr 9, 2020

If they have not released a fixed version by the time we are about to release Scrapy 2.1, we can change our documentation requirements temporarily to specify a Sphinx version older than 3, since we are not using anything specific of Sphinx 3 at the moment.

@anusha94 Given the circumstances, I think it makes sense for us to handle this from the core team.

@humitos
Copy link

@humitos humitos commented Apr 14, 2020

If we can't wait for the upcoming release as mentioned in readthedocs/sphinx-hoverxref#45 (comment), we might want to try temporarily disabling it in our configuration

Hi! I'm one of the authors of sphinx-hoverxref. I've already released 0.2b that includes the fix for Sphinx 3.0. I took a look at the PR and saw that the new warnings made your build to fail (I'm sorry for that), and I created a new issue to take a deeper look at this at readthedocs/sphinx-hoverxref#58

Besides, I saw that you are using some custom roles/objects like :setting:, :signal: and others, and I wanted to let you know that you can enable hoverxref on those as well with the config hoverxref_roles. See https://sphinx-hoverxref.readthedocs.io/en/dirhtml/usage/#tooltip-on-custom-object

Happy that an amazing project like Scrapy is using this extension! Thanks for making Scrapy 😄

@joybh98
Copy link
Contributor

@joybh98 joybh98 commented Apr 15, 2020

hey @elacuesta @Gallaecio I'm having the same issue, as I'm working on an issue regarding documentation. Can I be of any help to solve this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants