diff options
author | Federico Mena Quintero <federico@gnome.org> | 2022-12-13 15:13:05 -0600 |
---|---|---|
committer | Federico Mena Quintero <federico@gnome.org> | 2022-12-13 15:13:05 -0600 |
commit | 740f8a223a950bad2ba1d011d0e83cc8d4d6ceae (patch) | |
tree | b29a5a89d816576e16c925ed48f19fc1ce244c6d | |
parent | 149be314f5bcd650165b8f71dd364c80f0d4d634 (diff) | |
download | at-spi2-core-740f8a223a950bad2ba1d011d0e83cc8d4d6ceae.tar.gz |
devel-docs: Explicitly list the extracted interfaces from the XML files
It turns out that Event.xml has various interfaces in it, so
gdbus-codegen creates more than one file for it. So, manually list
the generated files for now.
-rw-r--r-- | devel-docs/meson.build | 44 | ||||
-rw-r--r-- | devel-docs/xml-interfaces.rst | 48 |
2 files changed, 65 insertions, 27 deletions
diff --git a/devel-docs/meson.build b/devel-docs/meson.build index 0e91f9da..b405df4f 100644 --- a/devel-docs/meson.build +++ b/devel-docs/meson.build @@ -6,17 +6,49 @@ sphinx_build = find_program('sphinx-build', native: true, required: get_option('docs')) -interfaces_rst_sources = [] +# Gather the XML files, prefixed by the "xml/" directory name +# introspection_sources comes from xml/meson.build interfaces_xml = [] - foreach i: introspection_sources - # /foo/bar/baz.xml -> doc-baz.rst - doc_name = 'doc-' + fs.replace_suffix(fs.name(i), '.rst') - interfaces_rst_sources += doc_name - interfaces_xml += join_paths(meson.project_source_root(), 'xml', i) endforeach +# gdbus-codegen can take an dbus.xml file and generate various interfaces +# from it, named as some_prefix-org.foo.InterfaceName.rst +# We need an explicit list of those; for example, xml/Event.xml contains +# various interfaces and so we can't just substitute "xml" for "rst". +interfaces_rst_sources = [ + 'doc-org.a11y.atspi.Accessible.rst', + 'doc-org.a11y.atspi.Action.rst', + 'doc-org.a11y.atspi.Application.rst', + 'doc-org.a11y.atspi.Cache.rst', + 'doc-org.a11y.atspi.Collection.rst', + 'doc-org.a11y.atspi.Component.rst', + 'doc-org.a11y.atspi.DeviceEventController.rst', + 'doc-org.a11y.atspi.DeviceEventListener.rst', + 'doc-org.a11y.atspi.Document.rst', + 'doc-org.a11y.atspi.EditableText.rst', + 'doc-org.a11y.atspi.Event.Document.rst', + 'doc-org.a11y.atspi.Event.Focus.rst', + 'doc-org.a11y.atspi.Event.Keyboard.rst', + 'doc-org.a11y.atspi.Event.Mouse.rst', + 'doc-org.a11y.atspi.Event.Object.rst', + 'doc-org.a11y.atspi.Event.Terminal.rst', + 'doc-org.a11y.atspi.Event.Window.rst', + 'doc-org.a11y.atspi.Hyperlink.rst', + 'doc-org.a11y.atspi.Hypertext.rst', + 'doc-org.a11y.atspi.Image.rst', + 'doc-org.a11y.atspi.Registry.rst', + 'doc-org.a11y.atspi.Selection.rst', + 'doc-org.a11y.atspi.Socket.rst', + 'doc-org.a11y.atspi.Table.rst', + 'doc-org.a11y.atspi.TableCell.rst', + 'doc-org.a11y.atspi.Text.rst', + 'doc-org.a11y.atspi.Value.rst', +] + +# The 'devel-docs/doc' here is a prefix that gdbus-codegen will put in front +# of the interface names that it finds in the input XML files. interfaces_rst = custom_target( 'interfaces_rst', input: interfaces_xml, diff --git a/devel-docs/xml-interfaces.rst b/devel-docs/xml-interfaces.rst index d384c972..447aa4a4 100644 --- a/devel-docs/xml-interfaces.rst +++ b/devel-docs/xml-interfaces.rst @@ -1,24 +1,30 @@ DBus XML Interfaces =================== -:doc:`doc-org.a11y.atspi.Accessible` -:doc:`doc-org.a11y.atspi.Action` -:doc:`doc-org.a11y.atspi.Application` -:doc:`doc-org.a11y.atspi.Cache` -:doc:`doc-org.a11y.atspi.Collection` -:doc:`doc-org.a11y.atspi.Component` -:doc:`doc-org.a11y.atspi.DeviceEventController` -:doc:`doc-org.a11y.atspi.DeviceEventListener` -:doc:`doc-org.a11y.atspi.Document` -:doc:`doc-org.a11y.atspi.EditableText` -:doc:`doc-org.a11y.atspi.Event` -:doc:`doc-org.a11y.atspi.Hyperlink` -:doc:`doc-org.a11y.atspi.Hypertext` -:doc:`doc-org.a11y.atspi.Image` -:doc:`doc-org.a11y.atspi.Registry` -:doc:`doc-org.a11y.atspi.Selection` -:doc:`doc-org.a11y.atspi.Socket` -:doc:`doc-org.a11y.atspi.Table` -:doc:`doc-org.a11y.atspi.TableCell` -:doc:`doc-org.a11y.atspi.Text` -:doc:`doc-org.a11y.atspi.Value` +* :doc:`doc-org.a11y.atspi.Accessible` +* :doc:`doc-org.a11y.atspi.Action` +* :doc:`doc-org.a11y.atspi.Application` +* :doc:`doc-org.a11y.atspi.Cache` +* :doc:`doc-org.a11y.atspi.Collection` +* :doc:`doc-org.a11y.atspi.Component` +* :doc:`doc-org.a11y.atspi.DeviceEventController` +* :doc:`doc-org.a11y.atspi.DeviceEventListener` +* :doc:`doc-org.a11y.atspi.Document` +* :doc:`doc-org.a11y.atspi.EditableText` +* :doc:`doc-org.a11y.atspi.Event.Document` +* :doc:`doc-org.a11y.atspi.Event.Focus` +* :doc:`doc-org.a11y.atspi.Event.Keyboard` +* :doc:`doc-org.a11y.atspi.Event.Mouse` +* :doc:`doc-org.a11y.atspi.Event.Object` +* :doc:`doc-org.a11y.atspi.Event.Terminal` +* :doc:`doc-org.a11y.atspi.Event.Window` +* :doc:`doc-org.a11y.atspi.Hyperlink` +* :doc:`doc-org.a11y.atspi.Hypertext` +* :doc:`doc-org.a11y.atspi.Image` +* :doc:`doc-org.a11y.atspi.Registry` +* :doc:`doc-org.a11y.atspi.Selection` +* :doc:`doc-org.a11y.atspi.Socket` +* :doc:`doc-org.a11y.atspi.Table` +* :doc:`doc-org.a11y.atspi.TableCell` +* :doc:`doc-org.a11y.atspi.Text` +* :doc:`doc-org.a11y.atspi.Value` |