doc/user: add a link to the API documentation in the TOC
authorPeter Hutterer <peter.hutterer@who-t.net>
Thu, 17 Oct 2019 03:53:07 +0000 (13:53 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Thu, 17 Oct 2019 08:31:28 +0000 (08:31 +0000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/user/index.rst
doc/user/meson.build

index aaa84d79ed1e9d8e8327df70946962123cd8c3cf..7aea1e6bb063e20c8c27f7e8d7fa25cbf5905a43 100644 (file)
@@ -11,6 +11,7 @@
   reporting-bugs
   troubleshooting
   development
+  API documentation <@HTTP_DOC_LINK@>
 
 
 ++++++++++++++++++++++++++++++
@@ -41,7 +42,7 @@ API documentation
 -----------------
 
 The API documentation is available here:
-    http://wayland.freedesktop.org/libinput/doc/latest/api/
+    https://wayland.freedesktop.org/libinput/doc/latest/api/
 
 .. note:: This documentation is generally only needed by authors of Wayland
          compositors or other developers dealing with input events directly.
index f9904f10cae6f69b11c62d5dab39eaf08688c900..c5dc32a4d143a675b7e4e6a90e7825bdd570df55 100644 (file)
@@ -8,6 +8,7 @@ sphinx_config = configuration_data()
 sphinx_config.set('PROJECT_NAME', meson.project_name())
 sphinx_config.set('PROJECT_VERSION', meson.project_version())
 sphinx_config.set('BUILDDIR', meson.current_build_dir())
+sphinx_config.set('HTTP_DOC_LINK', doc_url)
 
 git_version_page = vcs_tag(command : ['git', 'log', '-1', '--format=%H'],
                           fallback : 'unknown',
@@ -137,7 +138,6 @@ src_rst = files(
        'device-quirks.rst',
        'faqs.rst',
        'gestures.rst',
-       'index.rst',
        'middle-button-emulation.rst',
        'normalization-of-relative-motion.rst',
        'palm-detection.rst',
@@ -183,6 +183,10 @@ foreach f : src_rst
        src_sphinx += [ sf ]
 endforeach
 
+configure_file(input: 'index.rst',
+              output: 'index.rst',
+              configuration: sphinx_config)
+
 
 # do not use -j, it breaks on Ubuntu
 sphinx_output_dir = 'Documentation'