summaryrefslogtreecommitdiff
path: root/doc/_extensions
diff options
context:
space:
mode:
authorMartin Trigaux <mat@odoo.com>2018-10-23 15:56:58 +0200
committerMartin Trigaux <mat@odoo.com>2018-10-23 16:17:58 +0200
commita0050c323cbbd43de016978406f7832b18ade161 (patch)
treed3e9665f9618c77e5ab86b0e20539c7711675e8e /doc/_extensions
parent27cc2ae3a91ad7a2fb16923256a359406e8bd68c (diff)
[FIX] doc: backport of ac37ca39eaf to 10.0
To be compatible with sphinx >= 1.8
Diffstat (limited to 'doc/_extensions')
-rw-r--r--doc/_extensions/github_link.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/_extensions/github_link.py b/doc/_extensions/github_link.py
index cd0c5380621..b09177cf6e2 100644
--- a/doc/_extensions/github_link.py
+++ b/doc/_extensions/github_link.py
@@ -94,11 +94,12 @@ def add_doc_link(app, pagename, templatename, context, doctree):
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, basestring) 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, basestring):
+ 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)