docs/sphinx/qapidoc.py

30 from docutils import nodes
34 from sphinx.util.nodes import nested_parse_with_titles
81         self._top_node = nodes.section()
93         dlitem = nodes.definition_list_item()
94         dlterm = nodes.term('', '', *term)
97             dldef = nodes.definition()
99                 dldef += nodes.paragraph('', '', *defn)
107         section = nodes.section(ids=[self._sphinx_directive.new_serialno()])
109             section += nodes.title(title, title)
122         doc = nodes.literal('', doc)
126         nodelist = [nodes.Text(' ('), nodes.strong('', 'If: ')]
128         nodelist.append(nodes.Text(')'))
138         term = [nodes.literal('', member.name)]
140             term.append(nodes.Text(': '))
141             term.append(nodes.literal('', member.type.doc_type()))
143             term.append(nodes.Text(' (optional)'))
155         term = [nodes.Text(' when '),
156                 nodes.literal('', branches.tag_member.name),
157                 nodes.Text(' is '),
158                 nodes.literal('', '"%s"' % variant.name)]
165         dlnode = nodes.definition_list()
172                 defn = [nodes.Text('Not documented')]
177             dlnode += self._make_dlitem([nodes.Text('The members of '),
178                                          nodes.literal('', base.doc_type())],
186                 term = [nodes.Text('The members of '),
187                         nodes.literal('', v.type.doc_type())]
201         dlnode = nodes.definition_list()
203             termtext = [nodes.literal('', section.member.name)]
210                 defn = [nodes.Text('Not documented')]
227             dlnode = nodes.definition_list()
229                 [nodes.Text('The members of '),
230                  nodes.literal('', boxed_arg_type.name)],
240         dlnode = nodes.definition_list()
243                 [nodes.literal('', section.member.name)], section.text)
255         return [nodes.literal_block(exampletext, exampletext)]
277             snode += nodes.paragraph(
293         snode = nodes.section(ids=[self._sphinx_directive.new_serialno()])
294         snode += nodes.title('', '', *[nodes.literal(doc.symbol, doc.symbol),
295                                        nodes.Text(' (' + typ + ')')])