Skip to content
Snippets Groups Projects
Commit ac37ca39 authored by Xavier Morel's avatar Xavier Morel
Browse files

[FIX] doc: github_link compatibility with Sphinx 1.8

parent d2ba7050
No related branches found
No related tags found
No related merge requests found
......@@ -91,17 +91,17 @@ def make_github_link(app, path, line=None, mode="blob"):
'',
'' if line is None else 'L%d' % line
))
def add_doc_link(app, pagename, templatename, context, doctree):
""" Add github_link function linking to the current page on github """
if not app.config.github_user and app.config.github_project:
return
# FIXME: find other way to recover current document's source suffix
# in Sphinx 1.3 it's possible to have mutliple source suffixes and that
# may be useful in the future
source_suffix = app.config.source_suffix
source_suffix = source_suffix if isinstance(source_suffix, pycompat.string_types) else source_suffix[0]
# in 1.3 source_suffix can be a list
# in 1.8 source_suffix can be a mapping
# FIXME: will break if we ever add support for !rst markdown documents maybe
if not isinstance(source_suffix, pycompat.string_types):
source_suffix = next(iter(source_suffix))
# can't use functools.partial because 3rd positional is line not mode
context['github_link'] = lambda mode='edit': make_github_link(
app, 'doc/%s%s' % (pagename, source_suffix), mode=mode)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment