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

Fix the ReadTheDocs build #4373

Merged
merged 3 commits into from Feb 25, 2020
Merged

Fix the ReadTheDocs build #4373

merged 3 commits into from Feb 25, 2020

Conversation

Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented Feb 25, 2020

@kmike noticed that autodoc was not working, any API documentation extracted from comments was missing in master.

This started happening when we removed Scrapy dependencies from docs/requirements.txt. The build log issued warnings, but Read The Docs was not configured to fail the build in case of warnings. Travis CI would have failed, weren’t it because Tox automatically installs Scrapy from setup.py, which ReadTheDocs does not.

These changes add the dependencies back to the file, and make warnings cause build failures in ReadTheDocs.

You can see it working at https://scrapy-gallaecio.readthedocs.io/en/fix-readthedocs/topics/request-response.html

I also tried just enabling to fail on warning, and indeed the ReadTheDocs build failed after that.

docs/requirements.txt Outdated Show resolved Hide resolved
@codecov
Copy link

@codecov codecov bot commented Feb 25, 2020

Codecov Report

Merging #4373 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4373   +/-   ##
=======================================
  Coverage   84.13%   84.13%           
=======================================
  Files         166      166           
  Lines        9967     9967           
  Branches     1482     1482           
=======================================
  Hits         8386     8386           
  Misses       1325     1325           
  Partials      256      256

@kmike kmike merged commit 647cba0 into scrapy:master Feb 25, 2020
2 checks passed
@kmike
Copy link
Member

@kmike kmike commented Feb 25, 2020

Thanks @Gallaecio!

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.

None yet

2 participants