[IMP] doc: link directly to edition mode in docfiles

This commit is contained in:
Xavier Morel 2014-10-30 16:24:03 +01:00
parent 63e1afc5fd
commit 95265e9ba6
2 changed files with 5 additions and 13 deletions

View File

@ -2,7 +2,6 @@ import inspect
import importlib
import os.path
from urlparse import urlunsplit
import sphinx
def setup(app):
app.add_config_value('github_user', None, 'env')
@ -73,13 +72,6 @@ def add_doc_link(app, pagename, templatename, context, doctree):
if not app.config.github_user and app.config.github_project:
return
def github_doc_link(mode='blob'):
""" returns the github URL for the current page
:param str mode: 'edit' for edition view
"""
return make_github_link(
app,
'doc/%s%s' % (pagename, app.config.source_suffix),
mode=mode)
context['github_link'] = github_doc_link
# can't use functools.partial because 3rd positional is line not mode
context['github_link'] = lambda mode='mode': make_github_link(
app, 'doc/%s%s' % (pagename, app.config.source_suffix), mode=mode)

View File

@ -34,8 +34,8 @@
{{ toctree(maxdepth=4, collapse=False, includehidden=True,
main_navbar=False, titles_only=False) }}
{% if github_link %}
<p><a href="{{ github_link() }}" class="github">
View on GitHub
<p><a href="{{ github_link(mode='edit') }}" class="github">
Edit on GitHub
</a></p>
{% endif %}
</div>