pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIX] doc: github_link compatibility with Sphinx 1.8

Browse Source
This commit is contained in:
Xavier Morel
2018-09-25 16:28:18 +02:00
parent d2ba705019
commit ac37ca39ea
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/_extensions/github_link.py
+5 -5
View File
@@ -91,17 +91,17 @@ def make_github_link(app, path, line=None, mode="blob"):
'', '',
'' if line is None else 'L%d' % line '' if line is None else 'L%d' % line
)) ))
def add_doc_link(app, pagename, templatename, context, doctree): def add_doc_link(app, pagename, templatename, context, doctree):
""" Add github_link function linking to the current page on github """ """ Add github_link function linking to the current page on github """
if not app.config.github_user and app.config.github_project: if not app.config.github_user and app.config.github_project:
return 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 = 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 # can't use functools.partial because 3rd positional is line not mode
context['github_link'] = lambda mode='edit': make_github_link( context['github_link'] = lambda mode='edit': make_github_link(
app, 'doc/%s%s' % (pagename, source_suffix), mode=mode) app, 'doc/%s%s' % (pagename, source_suffix), mode=mode)