forked from drath/libratbag
a535897ae7
Better than the markdown we were using before, even though we're currently (ab)using the js/c++ domains for the structure. There is no DBus domain in sphinx yet. The main motivation was to get the enums into the documentation since they are exported ABI. Generating the documentation is quirky - we use doxygen to extract the comments from the C header file and then use XSLT to convert to .rst which sphinx can use. Still better than having to maintain even more copies of the enums. Since this is only of interest for maintainers that need to upload the documentation, it is turned off by default. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
21 lines
543 B
ReStructuredText
21 lines
543 B
ReStructuredText
.. libratbag documentation master file, created by
|
|
sphinx-quickstart on Wed Oct 11 13:45:08 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
**********************
|
|
The libratbag DBus API
|
|
**********************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
The DBus Interfaces <dbus.rst>
|
|
Enumerations <enums.rst>
|
|
|
|
This document describes the DBus API that is the public interface for
|
|
libratbag.
|
|
|
|
Note: **the DBus interface is subject to change**
|