docs/sphinx/qapidoc_legacy.py

31 from docutils import nodes
52     """A QAPI schema visitor which generates docutils/Sphinx nodes
54     This class builds up a tree of docutils/Sphinx nodes corresponding
61     nodes. Once you've added all the documentation via 'freeform' and
63     the final list of document nodes (in a form suitable for returning
69         self._top_node = nodes.section()
75         term should be a list of Text and literal nodes.
78         - a list of Text and literal nodes, which will be put into
81         dlitem = nodes.definition_list_item()
82         dlterm = nodes.term('', '', *term)
85             dldef = nodes.definition()
87                 dldef += nodes.paragraph('', '', *defn)
95         section = nodes.section(ids=[self._sphinx_directive.new_serialno()])
97             section += nodes.title(title, title)
101         """Return list of Text, literal nodes for the ifcond
110         doc = nodes.literal('', doc)
114         nodelist = [nodes.Text(' ('), nodes.strong('', 'If: ')]
116         nodelist.append(nodes.Text(')'))
120         """Return list of Text, literal nodes for this member
122         Return a list of doctree nodes which give text like
126         term = [nodes.literal('', member.name)]
128             term.append(nodes.Text(': '))
129             term.append(nodes.literal('', member.type.doc_type()))
131             term.append(nodes.Text(' (optional)'))
137         """Return list of Text, literal nodes for variant 'when' clause
139         Return a list of doctree nodes which give text like
143         term = [nodes.Text(' when '),
144                 nodes.literal('', branches.tag_member.name),
145                 nodes.Text(' is '),
146                 nodes.literal('', '"%s"' % variant.name)]
152         """Return list of doctree nodes for the table of members"""
153         dlnode = nodes.definition_list()
160                 defn = [nodes.Text('Not documented')]
165             dlnode += self._make_dlitem([nodes.Text('The members of '),
166                                          nodes.literal('', base.doc_type())],
174                 term = [nodes.Text('The members of '),
175                         nodes.literal('', v.type.doc_type())]
187         """Return list of doctree nodes for the table of enum values"""
189         dlnode = nodes.definition_list()
191             termtext = [nodes.literal('', section.member.name)]
198                 defn = [nodes.Text('Not documented')]
211         """Return list of doctree nodes for the arguments section"""
215             dlnode = nodes.definition_list()
217                 [nodes.Text('The members of '),
218                  nodes.literal('', arg_type.name)],
226         """Return list of doctree nodes for the table of features"""
228         dlnode = nodes.definition_list()
231                 [nodes.literal('', section.member.name)], dedent(section.text))
242         """Return list of doctree nodes for additional sections"""
252                 container = nodes.container()
263         """Return list of doctree nodes for the "If" section"""
267             snode += nodes.paragraph(
279         sections is a list of nodes for sections to add to the definition.
283         snode = nodes.section(ids=[self._sphinx_directive.new_serialno()])
284         snode += nodes.title('', '', *[nodes.literal(doc.symbol, doc.symbol),
285                                        nodes.Text(' (' + typ + ')')])
342         nodes for a symbol (which could be a 'command', 'object', 'event',
402             node = nodes.container()