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 some redirection links in documentation #1041

Closed
wants to merge 2 commits into from

Conversation

@dufferzafar
Copy link
Contributor

@dufferzafar dufferzafar commented Feb 6, 2015

This fixes #606.

I wrote this python script to fix the docs. It uses the linkcheck output to work.

Most of the links have been fixed but in the docs/news.rst file all github issues are referred using issue_role, even pull requests.

Like this line refers to issue 693. But 693 is actually a pull request!

Should I create a new role for pulls (in docs/_ext/scrapydocs.py) to fix them as well?

Fixes #606
@kmike
Copy link
Member

@kmike kmike commented Feb 27, 2015

Looks good, +1 to merge.
I'm fine with explicit /2/ links to python docs and /en/latest links to RTFD.

@eliasdorneles
Copy link
Member

@eliasdorneles eliasdorneles commented Mar 10, 2015

I don't understand why this build fails, it doesn't even touch the code.
Anyway, LGTM.

@kmike
Copy link
Member

@kmike kmike commented Mar 10, 2015

@eliasdorneles it failed because of #1034

@curita
Copy link
Member

@curita curita commented Mar 10, 2015

LGTM too, but I'd also add the script because we'll surely need it again. @dufferzafar can you add the linkfix.py script to the repo? I think we could create a folder under docs (let's say docs/utils) and put it there.

@dufferzafar
Copy link
Contributor Author

@dufferzafar dufferzafar commented Mar 11, 2015

@curita Will do that today. If there's anything else you need from the script, please let me know.

@pablohoffman
Copy link
Member

@pablohoffman pablohoffman commented Mar 12, 2015

what about adding a sub-command to documentation Makefile (docs/Makefile)?. There's already a linkcheck (using standard sphinx plugin: http://sphinx-doc.org/latest/_modules/sphinx/builders/linkcheck.html)

@curita
Copy link
Member

@curita curita commented Mar 12, 2015

@pablohoffman: @dufferzafar's script uses linkcheck output to fix those links. Maybe we could add a command in the Makefile that runs linkcheck and then runs this script?

Could be something like:

linkfix: linkcheck
    $(PYTHON) utils/linkfix.py
    @echo "Fixing redirecting links in docs has finished, check all replacements before committing them"
@kmike kmike added the docs label Mar 13, 2015
@pablohoffman
Copy link
Member

@pablohoffman pablohoffman commented Mar 17, 2015

@curita that sounds good, can you add and merge?

curita added a commit that referenced this pull request Mar 18, 2015
curita added a commit that referenced this pull request Mar 18, 2015
@curita
Copy link
Member

@curita curita commented Mar 18, 2015

Merged in e17f97e

@curita curita closed this Mar 18, 2015
@pablohoffman pablohoffman added this to the Scrapy 1.0 milestone Mar 19, 2015
@kmike kmike mentioned this pull request Mar 24, 2015
umrashrf pushed a commit to umrashrf/selectors that referenced this pull request Apr 12, 2015
nikan1996 pushed a commit to Scrapy-cn/Scrapy-docs-cn that referenced this pull request Jan 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

5 participants