From 932c731b52ab382a0ae7ae63ca7e2899c92c0d19 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Tue, 13 Dec 2022 14:02:34 -0600 Subject: WIP: add a page with the generated docs for the XML interfaces --- devel-docs/conf.py | 6 ++++++ devel-docs/index.rst | 2 ++ devel-docs/meson.build | 4 +++- devel-docs/xml-interfaces.rst | 24 ++++++++++++++++++++++++ 4 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 devel-docs/xml-interfaces.rst (limited to 'devel-docs') diff --git a/devel-docs/conf.py b/devel-docs/conf.py index 8b371a56..824c9d8b 100644 --- a/devel-docs/conf.py +++ b/devel-docs/conf.py @@ -14,6 +14,8 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +import os + # -- Project information ----------------------------------------------------- @@ -38,6 +40,10 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +include_patterns = [ + '**', # this is the default + os.path.join(os.environ['MESON_CURRENT_BUILD_DIR'], '*') # for generated doc-org.a11y.atspi.SomeInterface.rst +] # -- Options for HTML output ------------------------------------------------- diff --git a/devel-docs/index.rst b/devel-docs/index.rst index 8e34027b..62bc78ee 100644 --- a/devel-docs/index.rst +++ b/devel-docs/index.rst @@ -8,6 +8,7 @@ Development guide for the accessibility infrastructure roadmap toolkits xml-changes + xml-interfaces :maxdepth: 1 :caption: Contents: @@ -26,6 +27,7 @@ General documentation - :doc:`roadmap` - :doc:`toolkits` - :doc:`xml-changes` +- :doc:`xml-interfaces` Refactoring and cleanup ----------------------- diff --git a/devel-docs/meson.build b/devel-docs/meson.build index d8978fcc..3f8b7884 100644 --- a/devel-docs/meson.build +++ b/devel-docs/meson.build @@ -21,7 +21,7 @@ interfaces_rst = custom_target( 'interfaces_rst', input: interfaces_xml, output: interfaces_rst_sources, - command: [ gdbus_codegen, '--generate-rst', 'doc', '@INPUT@'] + command: [ gdbus_codegen, '--generate-rst', 'devel-docs/doc', '@INPUT@'] ) docs_sources = [ @@ -32,6 +32,7 @@ docs_sources = [ 'roadmap.rst', 'toolkits.rst', 'xml-changes.rst', + 'xml-interfaces.rst', ] custom_target( @@ -39,4 +40,5 @@ custom_target( input: docs_sources + interfaces_rst, output: 'devel-docs', command: [ sphinx_build, meson.current_source_dir(), '@OUTPUT@' ], + env: { 'MESON_CURRENT_BUILD_DIR': meson.current_build_dir() } ) diff --git a/devel-docs/xml-interfaces.rst b/devel-docs/xml-interfaces.rst new file mode 100644 index 00000000..d384c972 --- /dev/null +++ b/devel-docs/xml-interfaces.rst @@ -0,0 +1,24 @@ +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` -- cgit v1.2.1