[5daabd2] | 1 | from docutils import nodes |
---|
| 2 | from docutils.parsers.rst import directives |
---|
| 3 | |
---|
| 4 | from sphinx import addnodes |
---|
| 5 | from sphinx.roles import XRefRole |
---|
| 6 | from sphinx.locale import l_, _ |
---|
| 7 | from sphinx.directives import ObjectDescription |
---|
| 8 | from sphinx.domains import Domain, ObjType, Index |
---|
| 9 | from sphinx.util.compat import Directive |
---|
| 10 | from sphinx.util.nodes import make_refnode |
---|
| 11 | from sphinx.util.docfields import Field, TypedField |
---|
| 12 | |
---|
| 13 | """ |
---|
| 14 | :r:bsp:`sparc/sis` |
---|
| 15 | |
---|
| 16 | :r:arch:`sparc` |
---|
| 17 | |
---|
| 18 | :r:board:`...` |
---|
| 19 | |
---|
| 20 | :r:user:`amar` |
---|
| 21 | |
---|
| 22 | :r:list:`devel` |
---|
| 23 | """ |
---|
| 24 | |
---|
| 25 | role_name = { |
---|
| 26 | "bsp": "BSP", |
---|
| 27 | "arch": "Architecture", |
---|
| 28 | "board": "Board", |
---|
| 29 | "user": "User", |
---|
| 30 | "list": "Mailing List", |
---|
| 31 | "rtems": "`RTEMS`", |
---|
| 32 | } |
---|
| 33 | |
---|
| 34 | role_url = { |
---|
| 35 | "trac": ("Trac", "https://devel.rtems.org"), |
---|
| 36 | "devel": ("Developer Site", "https://devel.rtems.org"), |
---|
| 37 | "www": ("RTEMS Home", "https://www.rtems.org/"), |
---|
| 38 | "buildbot": ("Buildbot Instance", "https://buildbot.rtems.org/"), |
---|
| 39 | "builder": ("Builder Site", "https://builder.rtems.org/"), |
---|
| 40 | "docs": ("Documentation Site", "https://docs.rtems.org/"), |
---|
| 41 | "lists": ("Mailing Lists", "https://lists.rtems.org/"), |
---|
| 42 | "git": ("Git Repositories", "https://git.rtems.org/"), |
---|
| 43 | "review": ("Gerrit Code Review", "https://review.rtems.org/"), |
---|
| 44 | "bugs": ("Bugs Database", "https://devel.rtems.org/wiki/Bugs/"), |
---|
| 45 | "gsoc": ("Google Summer of Code", "https://devel.rtems.org/wiki/GSoC/"), |
---|
| 46 | "socis": ("ESA SOCIS", "https://devel.rtems.org/wiki/SOCIS/") |
---|
| 47 | } |
---|
| 48 | |
---|
| 49 | |
---|
| 50 | role_list = { |
---|
| 51 | "announce": ("Announce Mailing List", "https://lists.rtems.org/mailman/listinfo/announce/"), |
---|
| 52 | "bugs": ("Bugs Mailing List", "https://lists.rtems.org/mailman/listinfo/bugs/"), |
---|
| 53 | "devel": ("Developers Mailing List", "https://lists.rtems.org/mailman/listinfo/devel/"), |
---|
| 54 | "build": ("Build logs", "https://lists.rtems.org/mailman/listinfo/build"), |
---|
| 55 | "users": ("Users Mailing List", "https://lists.rtems.org/mailman/listinfo/users/"), |
---|
| 56 | "vc": ("Version Control Mailing List", "https://lists.rtems.org/mailman/listinfo/vc/"), |
---|
| 57 | } |
---|
| 58 | |
---|
| 59 | |
---|
| 60 | def rtems_resolve_role(name, rawtext, text, lineno, inliner, options={}, content=[]): |
---|
| 61 | role = name.split(":")[1] #XXX: is there a better way? |
---|
| 62 | |
---|
| 63 | try: |
---|
| 64 | if role == "list": |
---|
| 65 | text, url = role_list[text] |
---|
| 66 | elif role == "url": |
---|
| 67 | text, url = role_url[text] |
---|
| 68 | except KeyError: |
---|
| 69 | msg = inliner.reporter.error("rtems_resolve_role(): %s is not a valid %s" % (text, role)) |
---|
| 70 | err = inliner.problematic("ERROR: %s" % rawtext, None, msg) |
---|
| 71 | return [err], [msg] |
---|
| 72 | |
---|
| 73 | # XXX: how do you add an alt tag? |
---|
| 74 | node = nodes.reference(rawtext, text, refuri=url, **options) |
---|
| 75 | return [node], [] |
---|
| 76 | |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | class RTEMSXrefRole(XRefRole): |
---|
| 80 | def __init__(self, item, title, **kwargs): |
---|
| 81 | XRefRole.__init__(self, **kwargs) |
---|
| 82 | self.item = item |
---|
| 83 | self.title = title |
---|
| 84 | |
---|
| 85 | def process_link(self, env, refnode, has_explicit_title, title, target): |
---|
| 86 | if has_explicit_title: |
---|
| 87 | title = has_explicit_title |
---|
| 88 | |
---|
| 89 | return has_explicit_title or self.title, target |
---|
| 90 | |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | |
---|
| 94 | class RTEMSDomain(Domain): |
---|
| 95 | """RTEMS domain.""" |
---|
| 96 | |
---|
| 97 | name = "r" |
---|
| 98 | label = "RTEMS" |
---|
| 99 | |
---|
| 100 | directives = {} |
---|
| 101 | object_types = {} |
---|
| 102 | |
---|
| 103 | roles = { |
---|
| 104 | "bsp": RTEMSXrefRole("bsp", "BSP"), |
---|
| 105 | "arch": RTEMSXrefRole("arch", "Architecture"), |
---|
| 106 | "user": RTEMSXrefRole("user", "User"), |
---|
| 107 | "list": rtems_resolve_role, |
---|
| 108 | "url": rtems_resolve_role, |
---|
| 109 | } |
---|
| 110 | |
---|
| 111 | |
---|
| 112 | def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): |
---|
| 113 | info = "*info*" |
---|
| 114 | anchor = "*anchor*" |
---|
| 115 | title = "*title*" |
---|
| 116 | |
---|
| 117 | return make_refnode(builder, fromdocname, info, anchor, contnode, title) |
---|
| 118 | |
---|
| 119 | def merge_domaindata(self, docnames, otherdata): |
---|
| 120 | pass # XXX is this needed? |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | def setup(app): |
---|
| 125 | app.add_domain(RTEMSDomain) |
---|
| 126 | return {'version': "1.0", 'parallel_read_safe': True} |
---|