From 5f33ae8901319789cf7ff212c561a13bf86a5d04 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 28 Aug 2023 16:17:15 +0100 Subject: [PATCH 1/2] Generate missing docs for out arguments The reStructuredText generator is missing the documentation blocks for out arguments. --- gio/gdbus-2.0/codegen/codegen_rst.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/gio/gdbus-2.0/codegen/codegen_rst.py b/gio/gdbus-2.0/codegen/codegen_rst.py index b71347d92..6c9596e77 100644 --- a/gio/gdbus-2.0/codegen/codegen_rst.py +++ b/gio/gdbus-2.0/codegen/codegen_rst.py @@ -231,6 +231,13 @@ class RstCodeGenerator: f" {arg_desc}", "", ] + for a in m.out_args: + arg_desc = self._expand(a.doc_string, True) + res += [ + f"{a.name}", + f" {arg_desc}", + "", + ] res += [""] if m.since: res += [ From 5f8af01b8b7d28be30d5f8e470cfecb1daa0319f Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 28 Aug 2023 16:26:24 +0100 Subject: [PATCH 2/2] Generate RST anchors for methods, signals, and properties Don't rely on the titles. --- gio/gdbus-2.0/codegen/codegen_rst.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/gio/gdbus-2.0/codegen/codegen_rst.py b/gio/gdbus-2.0/codegen/codegen_rst.py index 6c9596e77..026ad675d 100644 --- a/gio/gdbus-2.0/codegen/codegen_rst.py +++ b/gio/gdbus-2.0/codegen/codegen_rst.py @@ -120,12 +120,12 @@ class RstCodeGenerator: def _generate_section(self, title, name): """Generates a section with the given title.""" res = [ + f".. _{name} {title}:", + "", "-" * len(title), title, "-" * len(title), "", - f".. {name} {title}:", - "", "", ] return "\n".join(res) @@ -142,6 +142,8 @@ class RstCodeGenerator: else: access = "readable" res += [ + ".. _{title}:", + "", title, "^" * len(title), "", @@ -216,6 +218,8 @@ class RstCodeGenerator: for m in iface.methods: title = f"{iface.name}.{m.name}" res += [ + ".. _{title}:", + "", title, "^" * len(title), "", @@ -292,6 +296,8 @@ class RstCodeGenerator: for s in iface.signals: title = f"{iface.name}::{s.name}" res += [ + ".. _{title}:", + "", title, "^" * len(title), "",