OSDN Git Service

docs/sphinx: add sphinx modules to include D-Bus documentation
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Tue, 5 Oct 2021 21:00:35 +0000 (01:00 +0400)
committerMarc-André Lureau <marcandre.lureau@redhat.com>
Tue, 21 Dec 2021 06:50:21 +0000 (10:50 +0400)
commit2668dc7b5d9f56d8c3e6d2876c526fddc7068eca
treeae68445b8b96de1378e3e8899808144b54d659a7
parent20f19713ef5a33bd9074bb87aea004c08a27be7b
docs/sphinx: add sphinx modules to include D-Bus documentation

Add a new dbus-doc directive to import D-Bus interfaces documentation
from the introspection XML. The comments annotations follow the
gtkdoc/kerneldoc style, and should be formatted with reST.

Note: I realize after the fact that I was implementing those modules
with sphinx 4, and that we have much lower requirements. Instead of
lowering the features and code (removing type annotations etc), let's
have a warning in the documentation when the D-Bus modules can't be
used, and point to the source XML file in that case.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Acked-by: Gerd Hoffmann <kraxel@redhat.com>
docs/conf.py
docs/sphinx/dbusdoc.py [new file with mode: 0644]
docs/sphinx/dbusdomain.py [new file with mode: 0644]
docs/sphinx/dbusparser.py [new file with mode: 0644]
docs/sphinx/fakedbusdoc.py [new file with mode: 0644]