docs/sphinx/dbusdomain.py

1 # D-Bus sphinx domain extension
5 # SPDX-License-Identifier: LGPL-2.1-or-later
7 # Author: Marc-André Lureau <marcandre.lureau@redhat.com>
22 from docutils.nodes import Element, Node
45     def get_index_text(self, modname: str, name: str) -> str:
51     ) -> None:
52         ifacename = self.env.ref_context.get("dbus:interface")
73     Implementation of ``dbus:interface``.
76     def get_index_text(self, ifacename: str, name: str) -> str:
79     def before_content(self) -> None:
80         self.env.ref_context["dbus:interface"] = self.arguments[0]
82     def after_content(self) -> None:
83         self.env.ref_context.pop("dbus:interface")
85     def handle_signature(self, sig: str, signode: desc_signature) -> str:
86         signode += addnodes.desc_annotation("interface ", "interface ")
90     def run(self) -> List[Node]:
91         _, node = super().run()
93         section = nodes.section(ids=[name + "-section"])
94         section += nodes.title(name, "%s interface" % name)
95         section += node
135     def get_index_text(self, ifacename: str, name: str) -> str:
138     def handle_signature(self, sig: str, signode: desc_signature) -> str:
186     def get_index_text(self, ifacename: str, name: str) -> str:
202             "emits-changed": directives.unchanged,
208     def get_index_text(self, ifacename: str, name: str) -> str:
211     def transform_content(self, contentnode: addnodes.desc_content) -> None:
215             access = _("read-only")
217             access = _("write-only")
226         emits = self.options.get("emits-changed", None)
236     def handle_signature(self, sig: str, signode: desc_signature) -> str:
247     def run(self) -> List[Node]:
254         refnode["dbus:interface"] = env.ref_context.get("dbus:interface")
263                 if dot != -1:
275     Index subclass to provide a D-Bus interfaces index.
279     localname = _("D-Bus Interfaces Index")
284     ) -> Tuple[List[Tuple[str, List[IndexEntry]]], bool]:
294                 if x[1].objtype == "interface"
327     Implementation of the D-Bus domain.
331     label = "D-Bus"
333         "interface": ObjType(_("interface"), "iface", "obj"),
339         "interface": DBusInterface,
351         "objects": {},  # fullname -> ObjectEntry
358     def objects(self) -> Dict[str, ObjectEntry]:
359         return self.data.setdefault("objects", {})  # fullname -> ObjectEntry
363     ) -> None:
366     def clear_doc(self, docname: str) -> None:
371     def find_obj(self, typ: str, name: str) -> Optional[Tuple[str, ObjectEntry]]:
373         if name[-2:] == "()":
374             name = name[:-2]
389         node: pending_xref,
391     ) -> Optional[Element]:
392         """Resolve the pending_xref *node* with the given *typ* and *target*."""
399     def get_objects(self) -> Iterator[Tuple[str, str, str, str, str, int]]: