granicus.if.org Git - esp-idf/blob - docs/link-roles.py

   1 # based on http://protips.readthedocs.io/link-roles.html
   2
   3 import re
   4 from docutils import nodes
   5 from local_util import run_cmd_get_output
   6
   7 def get_github_rev():
   8     path = run_cmd_get_output('git rev-parse --short HEAD')
   9     tag = run_cmd_get_output('git describe --exact-match')
  10     print ('Git commit ID: ', path)
  11     if len(tag):
  12         print ('Git tag: ', tag)
  13         path = tag
  14     return path
  15
  16
  17 def setup(app):
  18     baseurl = 'https://github.com/espressif/esp-idf'
  19     rev = get_github_rev()
  20     app.add_role('idf', autolink('{}/tree/{}/%s'.format(baseurl, rev)))
  21     app.add_role('idf_file', autolink('{}/blob/{}/%s'.format(baseurl, rev)))
  22     app.add_role('idf_raw', autolink('{}/raw/{}/%s'.format(baseurl, rev)))
  23     app.add_role('component', autolink('{}/tree/{}/components/%s'.format(baseurl, rev)))
  24     app.add_role('component_file', autolink('{}/blob/{}/components/%s'.format(baseurl, rev)))
  25     app.add_role('component_raw', autolink('{}/raw/{}/components/%s'.format(baseurl, rev)))
  26     app.add_role('example', autolink('{}/tree/{}/examples/%s'.format(baseurl, rev)))
  27     app.add_role('example_file', autolink('{}/blob/{}/examples/%s'.format(baseurl, rev)))
  28     app.add_role('example_raw', autolink('{}/raw/{}/examples/%s'.format(baseurl, rev)))
  29
  30 def autolink(pattern):
  31     def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
  32         m = re.search('(.*)\s*<(.*)>', text)
  33         if m:
  34             link_text = m.group(1)
  35             link = m.group(2)
  36         else:
  37             link_text = text
  38             link = text
  39         url = pattern % (link,)
  40         node = nodes.reference(rawtext, link_text, refuri=url, **options)
  41         return [node], []
  42     return role