X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=doc%2Fbindings%2Fpython%2Fext%2Fbt2sphinxurl.py;fp=doc%2Fbindings%2Fpython%2Fext%2Fbt2sphinxurl.py;h=d76cc1c777406f854f8f2bb3469c87db3ddcfaeb;hp=b3e2608a27e8ffd35d6ce8db6305bd62ac8160ec;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hpb=419d8c49bd978a59b8a0619d83cb6ba26b18f970 diff --git a/doc/bindings/python/ext/bt2sphinxurl.py b/doc/bindings/python/ext/bt2sphinxurl.py index b3e2608a..d76cc1c7 100644 --- a/doc/bindings/python/ext/bt2sphinxurl.py +++ b/doc/bindings/python/ext/bt2sphinxurl.py @@ -44,10 +44,10 @@ def _bt2man_role( bt2_version, name, rawtext, text, lineno, inliner, options=None, content=None ): # match a manual page reference - m = re.match(r'^([a-zA-Z0-9_.:-]+)\(([a-zA-Z0-9]+)\)$', text) + m = re.match(r"^([a-zA-Z0-9_.:-]+)\(([a-zA-Z0-9]+)\)$", text) if not m: - msg = 'Cannot parse manual page reference `{}`'.format(text) + msg = "Cannot parse manual page reference `{}`".format(text) inliner.reporter.severe(msg, line=lineno) return [inliner.problematic(rawtext, rawtext, msg)], [msg] @@ -57,17 +57,17 @@ def _bt2man_role( # create nodes: `ret_node` is the node to return page_node = docutils.nodes.strong(rawtext, page) - vol_node = docutils.nodes.inline(rawtext, '({})'.format(vol)) - man_node = docutils.nodes.inline(rawtext, '', page_node, vol_node) - ret_node = docutils.nodes.literal(rawtext, '', man_node) + vol_node = docutils.nodes.inline(rawtext, "({})".format(vol)) + man_node = docutils.nodes.inline(rawtext, "", page_node, vol_node) + ret_node = docutils.nodes.literal(rawtext, "", man_node) - if page.startswith('babeltrace2'): + if page.startswith("babeltrace2"): # Babeltrace 2 manual page: wrap `ret_node` with an external # link node - url_tmpl = 'https://babeltrace.org/docs/v{ver}/man{vol}/{page}.{vol}/' + url_tmpl = "https://babeltrace.org/docs/v{ver}/man{vol}/{page}.{vol}/" url = url_tmpl.format(ver=bt2_version, vol=vol, page=page) ret_node = docutils.nodes.reference( - rawtext, '', ret_node, internal=False, refuri=url + rawtext, "", ret_node, internal=False, refuri=url ) return [ret_node], [] @@ -77,17 +77,17 @@ def _bt2link_role( bt2_version, name, rawtext, text, lineno, inliner, options=None, content=None ): # match link text and URL - m = re.match(r'^([^<]+) <([^>]+)>$', text) + m = re.match(r"^([^<]+) <([^>]+)>$", text) if not m: - msg = 'Cannot parse link template `{}`'.format(text) + msg = "Cannot parse link template `{}`".format(text) inliner.reporter.severe(msg, line=lineno) return [inliner.problematic(rawtext, rawtext, msg)], [msg] link_text = m.group(1) # replace `@ver@` with the project's version - url = m.group(2).replace('@ver@', bt2_version) + url = m.group(2).replace("@ver@", bt2_version) # create and return an external link node node = docutils.nodes.reference(rawtext, link_text, internal=False, refuri=url) @@ -97,13 +97,13 @@ def _bt2link_role( def _add_roles(app): # add the extension's roles; the role functions above expect the # project's version as their first parameter - app.add_role('bt2man', functools.partial(_bt2man_role, app.config.version)) - app.add_role('bt2link', functools.partial(_bt2link_role, app.config.version)) + app.add_role("bt2man", functools.partial(_bt2man_role, app.config.version)) + app.add_role("bt2link", functools.partial(_bt2link_role, app.config.version)) def setup(app): - app.connect('builder-inited', _add_roles) + app.connect("builder-inited", _add_roles) return { - 'version': app.config.version, - 'parallel_read_safe': True, + "version": app.config.version, + "parallel_read_safe": True, }