Pin version for Sphinx and extensions, configure hoverxref #4480
Conversation
| @@ -295,3 +295,5 @@ | |||
| # ------------------------------------ | |||
|
|
|||
| hoverxref_auto_ref = True | |||
| hoverxref_project = "scrapy" | |||
There was a problem hiding this comment.
Apparently this is necessary now, otherwise we get
hoverxref extension is not fully configured. Set hoverxref_project and hoverxref_version in your conf.py file.
Setting: https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html#confval-hoverxref_project
Failed build: https://travis-ci.org/github/scrapy/scrapy/jobs/673517936#L286
| @@ -295,3 +295,12 @@ | |||
| # ------------------------------------ | |||
|
|
|||
| hoverxref_auto_ref = True | |||
| hoverxref_project = "scrapy" | |||
| hoverxref_version = release | |||
| hoverxref_role_types = { | |||
There was a problem hiding this comment.
This seems to be necessary too, otherwise we get
Using default style for unknown typ. Define it in hoverxref_role_types. typ=ref style=tooltip
Setting:
https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html#confval-hoverxref_role_types
Failed build: https://travis-ci.org/github/scrapy/scrapy/jobs/673579524#L1209
| @@ -1116,17 +1116,6 @@ multi-purpose thread pool used by various Scrapy components. Threaded | |||
| DNS Resolver, BlockingFeedStorage, S3FilesStore just to name a few. Increase | |||
| this value if you're experiencing problems with insufficient blocking IO. | |||
|
|
|||
| .. setting:: REDIRECT_MAX_TIMES | |||
There was a problem hiding this comment.
Removed to avoid errors about duplicate definitions, such as
/home/travis/build/scrapy/scrapy/docs/topics/settings.rst:1119:duplicate setting description of REDIRECT_MAX_TIMES, other instance in topics/downloader-middleware
https://travis-ci.org/github/scrapy/scrapy/jobs/673570891#L348
Codecov Report
@@ Coverage Diff @@
## master #4480 +/- ##
==========================================
- Coverage 84.79% 84.78% -0.02%
==========================================
Files 164 164
Lines 9887 9887
Branches 1468 1468
==========================================
- Hits 8384 8383 -1
Misses 1248 1248
- Partials 255 256 +1
|
PR scrapy#4480, merged to fix docs build
Co-Authored-By: Adrián Chaves <adrian@chaves.io>
|
Thanks @elacuesta and @Gallaecio! |
| @@ -295,3 +295,12 @@ | |||
| # ------------------------------------ | |||
|
|
|||
| hoverxref_auto_ref = True | |||
| hoverxref_project = "scrapy" | |||
| hoverxref_version = release | |||
There was a problem hiding this comment.
Hi! This breaks in production when rendered by Read the Docs.
You shouldn't override hoverxref_version and hoverxref_project since they are taken automatically from Read the Docs.
If you want to avoid your CI failing because of this, you can define the environment variables as Read the Docs does:
- READTHEDOCS_PROJECT=scrapy
- READTHEDOCS_VERSION=''
With the current configuration, all the versions built on Read the Docs will point to a different version on Read the Docs and this will conflict. For example, current master version in Read the Docs defines hoverxref_version='2.0.0' but that version does not exist on Read the Docs and the tooltip does not known where to get the content from.
Cheers,
There was a problem hiding this comment.
Thanks for the heads up @humitos!
There was a problem hiding this comment.
Many thanks for looking into this @humitos! 🚀
It's green! ✔️
Closes #4475