link-roles.py 1.5 KB

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