Commit graph

24 commits

Author SHA1 Message Date
Peter Hutterer
cbd4f35442 dox: switch to sphinx for the user-visible documentation
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>
2018-07-30 12:24:04 +10:00
Peter Hutterer
c1f010a6eb doc: indent all @note continuation lines
This isn't required by doxygen but for a potential switch to RTD/sphinx
(see #95) it helps having this set up correctly.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26 09:04:31 +10:00
Peter Hutterer
e3a842a26d doc: replace <a href> links with the doxygen markdown equivalent
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24 15:46:55 +10:00
Peter Hutterer
f4a253fb21 doc: replace <pre> with @verbatim
Be more consistent here

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24 12:22:49 +10:00
Peter Hutterer
d5c0aed8a3 doc: add a section to the FAQs "is libinput required for Wayland"
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19 11:39:35 +10:00
Peter Hutterer
eb77684be0 doc: fix references to a trackpoint range in the FAQs
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19 11:14:14 +10:00
Peter Hutterer
08dbfb94b5 doc: update docs to drop hwdb references
In favour of the device quirks system.

Fixes #55

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-21 11:13:30 +10:00
Peter Hutterer
64c73d7ae6 timer: change the timer offset warning to a client bug
This looks like a libinput bug (well, it does say "libinput bug" on the
package) but it hasn't been that for a long time. The cause is almost always
insufficient motivation to call libinput_dispatch() by the caller, or at least
not doing it with the celerity libinput demands (and deserves, if I may say
so).

Up-, down- or side-grade it to a client bug, so the outrage can be
directed elsewhere, preferably away from me. And add a section to the
documentation, just in case someone actually reads this stuff.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Olivier Fourdan <ofourdan@redhat.com>
2018-02-06 19:29:26 +10:00
Peter Hutterer
01da0ec1cb doc: more and more documentation about hwdb updates
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-30 10:21:15 +10:00
Peter Hutterer
c727ee7f23 doc: add a doc for trackpoints 2017-11-29 12:11:46 +10:00
Peter Hutterer
c67b74b45e doc: add a FAQ regarding "please add a configuration option"
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-08 21:42:16 +10:00
Peter Hutterer
940658e1b7 tablet: print what capability is missing when rejecting a device
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-10-26 11:01:29 +10:00
Peter Hutterer
35e411a2c6 doc: add another item to the FAQ
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-09-29 08:13:00 +10:00
Peter Hutterer
8a626394c9 doc: add a faq for synclient/syndaemon
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-04-28 10:12:29 +10:00
Peter Hutterer
bed7e62a0d doc: add documentation for touchpad pressure detection
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-04-26 12:38:15 +10:00
Peter Hutterer
00db4252f3 doc: link to tapping page from the FAQ
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-02-13 10:46:59 +10:00
Peter Hutterer
a5cefb76ac doc: add a table of contents to the FAQ
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-01-31 09:52:22 +10:00
Peter Hutterer
aae997e60e doc: update the FAQ entry with how config options are stored
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-01-30 10:11:21 +10:00
Peter Hutterer
60c8b07695 doc: fix wrong argument to udevadm hwdb
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-08-18 15:34:29 +10:00
Peter Hutterer
ae30353a73 doc: add some info about configuring devices in wayland/xorg
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-08-05 11:14:17 +10:00
Peter Hutterer
d0ea1855e8 doc: add a section to the FAQ on how to retrigger hwdb changes
I'm typing this way too often into bugreports

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-06-30 11:00:44 +10:00
Jason Gerecke
7095b765ac doc: fix more typos
Signed-off-by: Jason Gerecke <jason.gerecke@wacom.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2015-08-22 16:03:29 +10:00
Peter Hutterer
9129a20014 doc: add "mouse is too fast" to the FAQ
And reference libevdev's mouse-dpi-tool while we're at it.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2015-07-07 07:41:03 +10:00
Peter Hutterer
def69068a8 doc: add a FAQ page
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2015-06-01 15:43:58 +10:00