mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2025-12-28 00:20:08 +01:00
cbd4f35442
This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
49 lines
1.2 KiB
ReStructuredText
49 lines
1.2 KiB
ReStructuredText
.. _development:
|
|
|
|
==============================================================================
|
|
Information for developers
|
|
==============================================================================
|
|
|
|
Below is a list of topics of interest to developers, divided into
|
|
information for those **using** libinput as library in a Wayland compositor
|
|
or other project. The :ref:`hacking_on_libinput` section applies to developers working on
|
|
libinput itself.
|
|
|
|
.. _using_libinput_as_library:
|
|
|
|
*************************
|
|
Using libinput as library
|
|
*************************
|
|
|
|
.. note:: If you use libinput you should get in touch with the libinput
|
|
developers on the wayland-devel@lists.freedesktop.org mailing
|
|
lists
|
|
|
|
The API documentation is available here:
|
|
http://wayland.freedesktop.org/libinput/doc/latest/api/
|
|
|
|
Topics below explain some behaviors of libinput.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
absolute-axes.rst
|
|
absolute-coordinate-ranges.rst
|
|
normalization-of-relative-motion.rst
|
|
seats.rst
|
|
timestamps.rst
|
|
|
|
.. _hacking_on_libinput:
|
|
|
|
*******************
|
|
Hacking on libinput
|
|
*******************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
contributing.rst
|
|
architecture
|
|
test-suite.rst
|
|
pointer-acceleration.rst
|
|
device-configuration-via-udev.rst
|