summaryrefslogtreecommitdiff
path: root/Documentation/hid/index.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-06-28 09:19:59 -0300
committerBenjamin Tissoires <benjamin.tissoires@redhat.com>2019-07-02 10:19:34 +0200
commitcca4786174656673f89684347e0028c88df57031 (patch)
tree9ae5ebb561ac93fc6138758acaae1b1e5fdb8c9d /Documentation/hid/index.rst
parent763cf1f2d9bfc8349c5791689074c8c17edf660d (diff)
docs: hid: convert to ReST
Rename the HID documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. While here, fix the sysfs example from hid-sensor.txt, that has a lot of "?" instead of the proper UTF-8 characters that are produced by the tree command. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Benjamin Tissoires <benjamin.tissoires@redhat.com> Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Diffstat (limited to 'Documentation/hid/index.rst')
-rw-r--r--Documentation/hid/index.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/hid/index.rst b/Documentation/hid/index.rst
new file mode 100644
index 000000000000..af4324902622
--- /dev/null
+++ b/Documentation/hid/index.rst
@@ -0,0 +1,18 @@
+:orphan:
+
+=============================
+Human Interface Devices (HID)
+=============================
+
+.. toctree::
+ :maxdepth: 1
+
+ hiddev
+ hidraw
+ hid-sensor
+ hid-transport
+
+ uhid
+
+ hid-alps
+ intel-ish-hid