110 lines
5.1 KiB
Python
110 lines
5.1 KiB
Python
|
# based on http://protips.readthedocs.io/link-roles.html
|
||
|
|
|
||
|
|
from __future__ import print_function
|
||
|
|
from __future__ import unicode_literals
|
||
|
|
import re
|
||
|
|
import os
|
||
|
|
from docutils import nodes
|
||
|
|
from local_util import run_cmd_get_output
|
||
|
|
|
||
|
|
|
||
|
|
# TODO may need to optimize to get the correct git revision
|
||
|
|
def get_github_rev():
|
||
|
|
path = run_cmd_get_output('git rev-parse --short HEAD')
|
||
|
|
tag = run_cmd_get_output('git describe --exact-match')
|
||
|
|
print('Git commit ID: ', path)
|
||
|
|
if len(tag):
|
||
|
|
print('Git tag: ', tag)
|
||
|
|
path = tag
|
||
|
|
return path
|
||
|
|
|
||
|
|
|
||
|
|
def setup(app):
|
||
|
|
#rev = get_github_rev()
|
||
|
|
rev = ""
|
||
|
|
|
||
|
|
# links to files or folders on the GitHub
|
||
|
|
# baseurl = 'https://github.com/beken/armino'
|
||
|
|
# app.add_role('armino', autolink('{}/tree/{}/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('armino_file', autolink('{}/blob/{}/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('armino_raw', autolink('{}/raw/{}/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('component', autolink('{}/tree/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('component_file', autolink('{}/blob/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('component_raw', autolink('{}/raw/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('example', autolink('{}/tree/{}/projects/examples/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('example_file', autolink('{}/blob/{}/projects/examples/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('example_raw', autolink('{}/raw/{}/projects/examples/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('example', autolink('{}/tree/{}/projects/examples/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('middleware', autolink('{}/tree/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('middleware_file', autolink('{}/blob/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
# app.add_role('middleware_raw', autolink('{}/raw/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
|
||
|
|
rev = 'refs/heads/armino_main'
|
||
|
|
baseurl = 'http://192.168.0.46/gerrit/plugins/gitiles/iot/wcn'
|
||
|
|
app.add_role('armino', autolink('{}/projects/+/{}/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('armino_file', autolink('{}/projects/+/{}/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('armino_raw', autolink('{}/projects/+/{}/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('component', autolink('{}/projects/+/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('component_file', autolink('{}/projects/+/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('component_raw', autolink('{}/projects/+/{}/components/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('example', autolink('{}/projects/+/{}/examples/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('example_file', autolink('{}/projects/+/{}/examples/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('example_raw', autolink('{}/projects/+/{}/examples/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('middleware', autolink('{}/projects/+/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('middleware_file', autolink('{}/projects/+/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
app.add_role('middleware_raw', autolink('{}/projects/+/{}/middleware/%s'.format(baseurl, rev)))
|
||
|
|
|
||
|
|
# link to the current documentation file in specific language version
|
||
|
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||
|
|
if on_rtd:
|
||
|
|
# provide RTD specific commit identification to be included in the link
|
||
|
|
tag_rev = 'latest'
|
||
|
|
if (run_cmd_get_output('git rev-parse --short HEAD') != rev):
|
||
|
|
tag_rev = rev
|
||
|
|
else:
|
||
|
|
# if not on the RTD then provide generic identification
|
||
|
|
tag_rev = run_cmd_get_output('git describe --always')
|
||
|
|
|
||
|
|
DOCS_VERSION = os.getenv('DOCS_VERSION')
|
||
|
|
|
||
|
|
if DOCS_VERSION is None:
|
||
|
|
app.add_role('link_to_translation', crosslink('%s../../%s/latest/%s.html'))
|
||
|
|
else:
|
||
|
|
app.add_role('link_to_translation', crosslink('%s../../%s/{}/%s.html'.format(DOCS_VERSION)))
|
||
|
|
|
||
|
|
return {
|
||
|
|
'parallel_read_safe': True,
|
||
|
|
'parallel_write_safe': True,
|
||
|
|
}
|
||
|
|
#if len(tag_rev):
|
||
|
|
# app.add_role('link_to_translation', crosslink('%s../../%s/html/{}/%s.html'.format(tag_rev)))
|
||
|
|
#else:
|
||
|
|
#app.add_role('link_to_translation', crosslink('%s../../%s/html/%s.html'))
|
||
|
|
|
||
|
|
|
||
|
|
def autolink(pattern):
|
||
|
|
def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||
|
|
m = re.search('(.*)\s*<(.*)>', text) # noqa: W605 - regular expression
|
||
|
|
if m:
|
||
|
|
link_text = m.group(1)
|
||
|
|
link = m.group(2)
|
||
|
|
else:
|
||
|
|
link_text = text
|
||
|
|
link = text
|
||
|
|
url = pattern % (link,)
|
||
|
|
node = nodes.reference(rawtext, link_text, refuri=url, **options)
|
||
|
|
return [node], []
|
||
|
|
return role
|
||
|
|
|
||
|
|
|
||
|
|
def crosslink(pattern):
|
||
|
|
def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||
|
|
(language, link_text) = text.split(':')
|
||
|
|
docname = inliner.document.settings.env.docname
|
||
|
|
doc_path = inliner.document.settings.env.doc2path(docname, None)
|
||
|
|
return_path = '../' * doc_path.count('/')
|
||
|
|
url = pattern % (return_path, language, docname)
|
||
|
|
node = nodes.reference(rawtext, link_text, refuri=url, **options)
|
||
|
|
return [node], []
|
||
|
|
return role
|