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 broken Show Source links on documentation pages #3113

Conversation

ScriptingSquirrel
Copy link
Contributor

This fixes links that were accidentally pointing to sourcename.rst.rst files on GitHub by pointing them to the correct sourcename.rst files instead.

This corrects links that were accidentally pointing to `sourcename.rst.rst`
files on GitHub by pointing them to the correct `sourcename.rst` files instead.
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

@Mariatta
Copy link
Member

So this used to work in sphinx 1.4.9 😅
This change in Sphinx: sphinx-doc/sphinx#2454, introduced in Sphinx 1.5.1 broke this behavior.
Thanks so much for catching and fixing this @elritsch 🌮

@Mariatta Mariatta merged commit b9ff498 into python:master Aug 18, 2017
Mariatta pushed a commit to Mariatta/cpython that referenced this pull request Aug 18, 2017
…-3113)

The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".
(cherry picked from commit b9ff498)
@bedevere-bot
Copy link

GH-3125 is a backport of this pull request to the 3.6 branch.

Mariatta pushed a commit to Mariatta/cpython that referenced this pull request Aug 18, 2017
…-3113)

The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".
(cherry picked from commit b9ff498)
Mariatta added a commit to Mariatta/cpython that referenced this pull request Aug 18, 2017
The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".

(cherry picked from commit b9ff498)
@bedevere-bot
Copy link

GH-3128 is a backport of this pull request to the 2.7 branch.

@ScriptingSquirrel ScriptingSquirrel deleted the fix-broken-source-links-in-documentation-pages branch August 18, 2017 08:13
Mariatta added a commit that referenced this pull request Aug 18, 2017
)

The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".
(cherry picked from commit b9ff498)
Mariatta added a commit that referenced this pull request Aug 18, 2017
)

The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".

(cherry picked from commit b9ff498)
ned-deily pushed a commit that referenced this pull request Sep 8, 2017
…#3126)

The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt".
(cherry picked from commit b9ff498)
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.

4 participants