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 | "ftp": ("FTP File Server", "https://ftp.rtems.org/"), |
---|
44 | "review": ("Gerrit Code Review", "https://review.rtems.org/"), |
---|
45 | "bugs": ("Bugs Database", "https://devel.rtems.org/wiki/Bugs/"), |
---|
46 | "gsoc": ("Google Summer of Code", "https://devel.rtems.org/wiki/GSoC/"), |
---|
47 | "socis": ("ESA SOCIS", "https://devel.rtems.org/wiki/SOCIS/") |
---|
48 | } |
---|
49 | |
---|
50 | |
---|
51 | role_list = { |
---|
52 | "announce": ("Announce Mailing List", "https://lists.rtems.org/mailman/listinfo/announce/"), |
---|
53 | "bugs": ("Bugs Mailing List", "https://lists.rtems.org/mailman/listinfo/bugs/"), |
---|
54 | "devel": ("Developers Mailing List", "https://lists.rtems.org/mailman/listinfo/devel/"), |
---|
55 | "build": ("Build logs", "https://lists.rtems.org/mailman/listinfo/build"), |
---|
56 | "users": ("Users Mailing List", "https://lists.rtems.org/mailman/listinfo/users/"), |
---|
57 | "vc": ("Version Control Mailing List", "https://lists.rtems.org/mailman/listinfo/vc/"), |
---|
58 | } |
---|
59 | |
---|
60 | |
---|
61 | def rtems_resolve_role(name, rawtext, text, lineno, inliner, options={}, content=[]): |
---|
62 | role = name.split(":")[1] #XXX: is there a better way? |
---|
63 | |
---|
64 | try: |
---|
65 | if role == "list": |
---|
66 | text, url = role_list[text] |
---|
67 | elif role == "url": |
---|
68 | text, url = role_url[text] |
---|
69 | except KeyError: |
---|
70 | msg = inliner.reporter.error("rtems_resolve_role: '%s' is not a valid %s" % (text, role)) |
---|
71 | err = inliner.problematic("ERROR: %s" % rawtext, None, msg) |
---|
72 | return [err], [msg] |
---|
73 | |
---|
74 | # XXX: how do you add an alt tag? |
---|
75 | node = nodes.reference(rawtext, text, refuri=url, **options) |
---|
76 | return [node], [] |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | class RTEMSXrefRole(XRefRole): |
---|
81 | def __init__(self, item, title, **kwargs): |
---|
82 | XRefRole.__init__(self, **kwargs) |
---|
83 | self.item = item |
---|
84 | self.title = title |
---|
85 | |
---|
86 | def process_link(self, env, refnode, has_explicit_title, title, target): |
---|
87 | if has_explicit_title: |
---|
88 | title = has_explicit_title |
---|
89 | |
---|
90 | return has_explicit_title or self.title, target |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | class RTEMSDomain(Domain): |
---|
96 | """RTEMS domain.""" |
---|
97 | |
---|
98 | name = "r" |
---|
99 | label = "RTEMS" |
---|
100 | |
---|
101 | directives = {} |
---|
102 | object_types = {} |
---|
103 | |
---|
104 | roles = { |
---|
105 | "bsp": RTEMSXrefRole("bsp", "BSP"), |
---|
106 | "arch": RTEMSXrefRole("arch", "Architecture"), |
---|
107 | "user": RTEMSXrefRole("user", "User"), |
---|
108 | "list": rtems_resolve_role, |
---|
109 | "url": rtems_resolve_role, |
---|
110 | } |
---|
111 | |
---|
112 | |
---|
113 | def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): |
---|
114 | info = "*info*" |
---|
115 | anchor = "*anchor*" |
---|
116 | title = "*title*" |
---|
117 | |
---|
118 | return make_refnode(builder, fromdocname, info, anchor, contnode, title) |
---|
119 | |
---|
120 | def merge_domaindata(self, docnames, otherdata): |
---|
121 | pass # XXX is this needed? |
---|
122 | |
---|
123 | |
---|
124 | |
---|
125 | def setup(app): |
---|
126 | app.add_domain(RTEMSDomain) |
---|
127 | return {'version': "1.0", 'parallel_read_safe': True} |
---|