Visitar URL original
[backport to 3.6] bpo-28929: Link the documentation to its source file on GitHub by Mariatta · Pull Request #37 · python/cpython · GitHub
Skip to content

[backport to 3.6] bpo-28929: Link the documentation to its source file on GitHub #37

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.

Sign up for GitHub

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

Merged
Mariatta merged 2 commits into from
Feb 12, 2017
Merged

[backport to 3.6] bpo-28929: Link the documentation to its source file on GitHub #37

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e978c26
bpo-28929: Link the documentation to its source file on GitHub
Mariatta Feb 12, 2017
424a1d7
remove if statement
Mariatta Feb 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
bpo-28929: Link the documentation to its source file on GitHub 
Change the documentation's `Show Source` link on the left menu
to GitHub source file.

(cherry picked from commit 23bafa2)
  • Loading branch information
@Mariatta
Mariatta committed Feb 12, 2017
commit e978c26e31074e4fa1867bb0400b642223ec5fc2
10 changes: 8 additions & 2 deletions Doc/tools/templates/customsourcelink.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
<h3>{{ _('This Page') }}</h3>
<ul class="this-page-menu">
<li><a href="{{ pathto('bugs') }}">{% trans %}Report a Bug{% endtrans %}</a></li>
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
rel="nofollow">{{ _('Show Source') }}</a></li>
<li>
{% if version == "3.7" %}

@methane methane Feb 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this updated when Python 3.7 is released?
I think 2.7, 3.5, and 3.6 branch should not have this if statement.
Or could we pass variable like doc_source_url_prefix = "https://github.com/python/cpython/blob/3.6/Doc/" from conf?

@Mariatta Mariatta Feb 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review, @methane :)
I removed the if statement as suggested.
Branches 2.7, 3.5, and 3.6 don't have the if statement anymore.

{% set version = 'master' %}
{% endif %}
<a href="https://github.com/python/cpython/blob/{{ version }}/Doc/{{ sourcename|replace('txt', 'rst') }}"
rel="nofollow">{{ _('Show Source') }}
</a>
</li>
</ul>
</div>
{%- endif %}