12 qapidoc is a Sphinx extension that implements the qapi-doc directive
17 It implements one new rST directive, "qapi-doc::".
18 Each qapi-doc:: directive takes one argument, which is the
25 https://www.sphinx-doc.org/en/master/development/index.html
107         doc = ifcond.docgen()
108         if not doc:
110         doc = nodes.literal('', doc)
112             return [doc]
115         nodelist.append(doc)
151     def _nodes_for_members(self, doc, what, base=None, branches=None):  argument
154         for section in doc.args.values():
186     def _nodes_for_enum_values(self, doc):  argument
190         for section in doc.args.values():
210     def _nodes_for_arguments(self, doc, arg_type):  argument
213             assert not doc.args
223         return self._nodes_for_members(doc, 'Arguments')
225     def _nodes_for_features(self, doc):  argument
229         for section in doc.features.values():
241     def _nodes_for_sections(self, doc):  argument
244         for section in doc.sections:
282         doc = self._cur_doc
284         snode += nodes.title('', '', *[nodes.literal(doc.symbol, doc.symbol),
286         self._parse_text_into_node(doc.body.text, snode)
293         doc = self._cur_doc
295                       self._nodes_for_enum_values(doc)
296                       + self._nodes_for_features(doc)
297                       + self._nodes_for_sections(doc)
302         doc = self._cur_doc
306                       self._nodes_for_members(doc, 'Members', base, branches)
307                       + self._nodes_for_features(doc)
308                       + self._nodes_for_sections(doc)
313         doc = self._cur_doc
315                       self._nodes_for_members(doc, 'Members')
316                       + self._nodes_for_features(doc)
317                       + self._nodes_for_sections(doc)
323         doc = self._cur_doc
325                       self._nodes_for_arguments(doc, arg_type)
326                       + self._nodes_for_features(doc)
327                       + self._nodes_for_sections(doc)
331         doc = self._cur_doc
333                       self._nodes_for_arguments(doc, arg_type)
334                       + self._nodes_for_features(doc)
335                       + self._nodes_for_sections(doc)
338     def symbol(self, doc, entity):  argument
347         self._cur_doc = doc
356         heading. Subsequent document sections (commands, freeform doc chunks,
374     def freeform(self, doc):  argument
387         assert not doc.sections
388         assert not doc.args
389         assert not doc.features
390         self._cur_doc = doc
392         text = doc.body.text
408         """Parse a chunk of QAPI-doc-format text into the node
410         The doc comment can contain most inline rST markup, including
422             # of the doc comment, rather than the actual location of the error.
424             # to track lines more exactly within all the sub-parts of the doc