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

Extend hoverxref_roles to custom crossrefs (#4495) #4563

Merged
merged 2 commits into from Jun 1, 2020

Conversation

willbeaufoy
Copy link
Contributor

@willbeaufoy willbeaufoy commented May 10, 2020

Additionally, I think the documentation in docs/README.rst is out
of date: none of the commands built the docs properly for me (I had to
revert the changes in 901892d to docs/conf.py to get them to build
properly, and even then no tooltips displayed).

Building them with tox worked for me, but other developers say they
can still use the original method, so the docs now contain both.

Fixes #4495.

@codecov
Copy link

codecov bot commented May 10, 2020

Codecov Report

Merging #4563 into master will increase coverage by 0.39%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4563      +/-   ##
==========================================
+ Coverage   84.53%   84.93%   +0.39%     
==========================================
  Files         164      164              
  Lines        9908    10188     +280     
  Branches     1475     1550      +75     
==========================================
+ Hits         8376     8653     +277     
- Misses       1266     1270       +4     
+ Partials      266      265       -1     
Impacted Files Coverage Δ
scrapy/spiders/sitemap.py 80.64% <0.00%> (-0.31%) ⬇️
scrapy/responsetypes.py 94.02% <0.00%> (-0.09%) ⬇️
scrapy/spiders/crawl.py 92.39% <0.00%> (-0.09%) ⬇️
scrapy/mail.py 73.75% <0.00%> (ø)
scrapy/shell.py 68.21% <0.00%> (ø)
scrapy/cmdline.py 67.74% <0.00%> (ø)
scrapy/signals.py 100.00% <0.00%> (ø)
scrapy/squeues.py 96.77% <0.00%> (ø)
scrapy/robotstxt.py 97.53% <0.00%> (ø)
scrapy/utils/url.py 100.00% <0.00%> (ø)
... and 19 more

Copy link
Member

@Gallaecio Gallaecio left a comment

Works like a charm!

You can test it locally by editing tox.ini to point to my copy of @willbeaufoy’s branch deployed at https://scrapy-gallaecio.readthedocs.io/en/hoverxref/

setenv =
    READTHEDOCS_PROJECT=scrapy-gallaecio
    READTHEDOCS_VERSION=hoverxref

docs/README.rst Outdated Show resolved Hide resolved
docs/README.rst Outdated Show resolved Hide resolved
None of the existing commands built the docs properly for me (I had to
revert the changes in 901892d to docs/conf.py to get them to build
properly, and even then no tooltips displayed).

Building them with tox worked for me, but other developers say they
can still use the original method, so the docs now contain both.
Copy link
Member

@elacuesta elacuesta left a comment

Looks good. Latest build error is completely unrelated, looks like a Travis glitch, safe to ignore IMHO.
Thanks!

@Gallaecio Gallaecio merged commit c86a103 into scrapy:master Jun 1, 2020
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants